|
1 | 1 | # LSPService
|
2 | 2 |
|
3 |
| -π©π»βπ *This project is still a tad experimental. Contributors and pioneers welcome!* |
| 3 | +π©π»βπ *This project [is still a tad experimental](#development-status). Contributors and pioneers welcome!* |
4 | 4 |
|
5 | 5 | ## What?
|
6 | 6 |
|
@@ -97,6 +97,15 @@ Here are the internal composition and dependencies of LSPService:
|
97 | 97 |
|
98 | 98 | The above image was created with the [Codeface.io](https://www.codeface.io) app.
|
99 | 99 |
|
| 100 | +## Development Status |
| 101 | + |
| 102 | +From version/tag 0.1.0 on, LSPService adheres to [semantic versioning](https://semver.org). So until we've reached 1.0.0, the REST API or setup mechanism may still break frequently, but this will be expressed in version bumps. |
| 103 | + |
| 104 | +LSPService is already being used in production, but [Codeface](https://codeface.io) is still its primary client. LSPService will move to version 1.0.0 as soon as: |
| 105 | + |
| 106 | +1. Basic practicality and conceptual soundness have been validated by serving multiple real-world clients. |
| 107 | +2. LSPService has a versioning mechanism (see roadmap). |
| 108 | + |
100 | 109 | ## To Do / Roadmap
|
101 | 110 |
|
102 | 111 | * [x] Implement proof of concept with WebSockets and sourcekit-lsp
|
@@ -162,6 +171,13 @@ The above image was created with the [Codeface.io](https://www.codeface.io) app.
|
162 | 171 |
|
163 | 172 | * Result: [it does](https://apps.apple.com/app/codeface/id1578175415) π₯³. The second update was also accepted with full on promotion of features that depend on LSPService, but still referencing LSPService only from within the app.
|
164 | 173 |
|
| 174 | +* [ ] π’ Add a versioning mechanism that allows developing LSPService while multiple editors/clients depend on it. This may need to involve: |
| 175 | + * The REST API provides available versions via a GET request |
| 176 | + * The REST API includes explicit version numbers in its endpoint URLs |
| 177 | + * LSPService outputs its version on launch |
| 178 | + * Downloadable binaries somehow indicate their version |
| 179 | + * Codeface (as proof of concept by the pioneering client) can handle an outdated installation of LSPService |
| 180 | + |
165 | 181 | * [ ] βπ» Sign/notarize LSPService so it's easier to install and trust
|
166 | 182 |
|
167 | 183 | * [ ] π Experiment again with python language servers (and get one to work)
|
|
0 commit comments