Skip to content

Commit e43877d

Browse files
committed
Document development status
1 parent bbf3501 commit e43877d

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

β€ŽREADME.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LSPService
22

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!*
44

55
## What?
66

@@ -97,6 +97,15 @@ Here are the internal composition and dependencies of LSPService:
9797

9898
The above image was created with the [Codeface.io](https://www.codeface.io) app.
9999

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+
100109
## To Do / Roadmap
101110

102111
* [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.
162171

163172
* 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.
164173

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+
165181
* [ ] ✍🏻 Sign/notarize LSPService so it's easier to install and trust
166182

167183
* [ ] 🐍 Experiment again with python language servers (and get one to work)

0 commit comments

Comments
Β (0)