LSP: Using a virtual filesystem #524
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a primitive notion of a "virtual filesystem" (which is just a `Map<String, String>` for now) to represent abra files that require typechecking but which have not yet been saved to disk. For now, the contents of this map are wholesale replaced upon receipt of a `textDocument/didChange` notification from the LSP client, and removed upon `textDocument/didSave` (since at that point, the file can once again be read from disk to obtain the latest version). In the future, there ought to be a more sophisticated way of representing the file contents in the virtual filesystem, which leverages the Incremental `contentChange` option for `textDocument/didChange` notifications, rather than having to wastefully parse and replace the entire contents of the document each time. In fact, the LSP currently falls over when trying to operate on large files, most likely for this reason.
Using this current approach, the entire contents of the changed file will be sent in `textDocument/didChange` events (as well as `textDocument/didOpen`, which is less relevant but still wasteful). Until a more performant system is developed to leverage Incremental didChange events, let's only run diagnostics on save and instruct the client to not send didOpen or didChange events. Additionally, we instruct the client to not send the file contents in the didSave event.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a primitive notion of a "virtual filesystem" (which is just a
Map<String, String>for now) to represent abra files that require typechecking but which have not yet been saved to disk. For now, the contents of this map are wholesale replaced upon receipt of atextDocument/didChangenotification from the LSP client, and removed upontextDocument/didSave(since at that point, the file can once again be read from disk to obtain the latest version).In the future, there ought to be a more sophisticated way of representing the file contents in the virtual filesystem, which leverages the Incremental
contentChangeoption fortextDocument/didChangenotifications, rather than having to wastefully parse and replace the entire contents of the document each time. In fact, the LSP currently falls over when trying to operate on large files, most likely for this reason.