Skip to content

Commit b3ec670

Browse files
Jonathan D.A. Jewellclaude
andcommitted
chore: sync template files and configuration
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 5b92e4f commit b3ec670

3 files changed

Lines changed: 828 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Planned
11+
- JWT-based authentication for HTTP API
12+
- Rate limiting for all endpoints
13+
- TLS support for encrypted connections
14+
- WASM core module for sandboxed conversion execution
15+
- Advanced format support (YAML, XML, TOML)
16+
- Plugin system for custom converters
17+
- LSP 3.18 feature support
18+
- Performance optimizations
19+
20+
## [0.1.0] - 2025-11-22
21+
22+
### Added
23+
- **LSP Server**: Complete LSP 3.17 implementation with tower-lsp
24+
- Document synchronization (didOpen, didChange, didSave, didClose)
25+
- Code completion with format-aware suggestions
26+
- Hover information showing document statistics
27+
- Execute commands for document conversion
28+
- Diagnostic validation for document formats
29+
- **HTTP REST API**: Full REST API with axum
30+
- POST /api/convert - Convert documents between formats
31+
- GET /api/documents - List all documents
32+
- GET /api/documents/:id - Get specific document
33+
- DELETE /api/documents/:id - Delete document
34+
- POST /api/validate - Validate document format
35+
- GET /api/stats - Server statistics
36+
- GET /api/health - Health check endpoint
37+
- **WebSocket Server**: Real-time document updates
38+
- Subscribe/unsubscribe to document changes
39+
- Document update notifications
40+
- Ping/pong keepalive
41+
- Broadcast messaging
42+
- **Conversion Engine**: Bidirectional format conversion
43+
- Markdown ↔ HTML (full support via pulldown-cmark)
44+
- Markdown ↔ JSON (structured representation)
45+
- HTML ↔ JSON (DOM structure extraction)
46+
- Format validation and diagnostics
47+
- **Document Store**: Lock-free concurrent storage
48+
- DashMap for thread-safe operations
49+
- Document versioning
50+
- Metadata tracking (creation time, modification time)
51+
- UUID-based identification
52+
- **Editor Clients**: 7 editor integrations (all <100 LOC)
53+
- VS Code extension (~70 LOC)
54+
- Neovim plugin (~65 LOC)
55+
- Emacs package (~75 LOC)
56+
- JetBrains plugin (~55 LOC)
57+
- Sublime Text plugin (~60 LOC)
58+
- Zed configuration
59+
- Helix configuration
60+
- **Web UI**: Single-page application
61+
- Live document converter
62+
- Real-time dashboard with WebSocket updates
63+
- Document manager interface
64+
- Server statistics display
65+
- Responsive design for mobile/desktop
66+
- **Infrastructure**:
67+
- Dockerfile with multi-stage builds
68+
- docker-compose.yml for orchestration
69+
- podman-compose.yml for Podman support
70+
- Comprehensive Makefile with 20+ targets
71+
- Example configurations and conversions
72+
- **Documentation**:
73+
- Complete README with quick start
74+
- API documentation with examples
75+
- CONTRIBUTING.md for developers
76+
- SECURITY.md for security policies
77+
- CODE_OF_CONDUCT.md for community
78+
- MAINTAINERS.md for governance
79+
- **Testing**:
80+
- LSP compliance test suite
81+
- HTTP API integration tests
82+
- Core conversion engine tests
83+
- Document store concurrency tests
84+
- **RSR Compliance**:
85+
- .well-known/security.txt (RFC 9116)
86+
- .well-known/ai.txt (AI training policies)
87+
- .well-known/humans.txt (attribution)
88+
- justfile with build recipes
89+
- flake.nix for Nix reproducible builds
90+
- .gitlab-ci.yml for CI/CD
91+
92+
### Changed
93+
- N/A (initial release)
94+
95+
### Deprecated
96+
- N/A (initial release)
97+
98+
### Removed
99+
- N/A (initial release)
100+
101+
### Fixed
102+
- N/A (initial release)
103+
104+
### Security
105+
- Memory safety guaranteed by Rust ownership system
106+
- No unsafe code blocks in implementation
107+
- Input validation for all HTTP endpoints
108+
- LSP message validation
109+
- CORS enabled for web UI access
110+
111+
## Version History
112+
113+
- [0.1.0] - 2025-11-22: Initial release with core functionality
114+
115+
## Migration Guides
116+
117+
### From Non-LSP Solutions
118+
119+
If migrating from traditional editor-specific plugins:
120+
121+
1. **Install Server**: Build and install the Rust server
122+
2. **Install Client**: Install editor-specific client for your editor
123+
3. **Configure**: Set server path in client configuration
124+
4. **Test**: Open a Markdown/HTML/JSON file and test conversion commands
125+
126+
### Future Migrations
127+
128+
When upgrading to future versions, consult version-specific migration guides.
129+
130+
## Deprecation Policy
131+
132+
- **Minor versions**: Features deprecated with 6-month warning
133+
- **Major versions**: Breaking changes allowed with migration guide
134+
- **Security**: Immediate deprecation if security risk identified
135+
136+
## Support
137+
138+
- **Current Version**: 0.1.0 (active development)
139+
- **LTS**: Not yet designated
140+
- **EOL**: None yet
141+
142+
## Links
143+
144+
- [Repository](https://github.com/universal-connector/universal-language-connector)
145+
- [Issue Tracker](https://github.com/universal-connector/universal-language-connector/issues)
146+
- [Documentation](https://universal-connector.org/docs)
147+
- [Changelog](https://github.com/universal-connector/universal-language-connector/blob/main/CHANGELOG.md)
148+
149+
---
150+
151+
**Changelog Format**: [Keep a Changelog](https://keepachangelog.com/)
152+
**Versioning**: [Semantic Versioning](https://semver.org/)

0 commit comments

Comments
 (0)