Use a text document's language_id instead of file extensions
#434
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
When identifying where a given position is (python vs rst vs docstring) use the document's `lanuage_id` field where possible. This handles situations where a user has configured `*.txt` files in VSCode to be treated as rst files. If the document's language id is not available, then we fall back to using file extensions as we did previously
The check for whether we should parse a document in `get_initial_doctree` now relies on `get_location_type` rather than checking the file extension. This means that files that don't have the traditional `*.rst` extension but are treated by the client as reStructuredText documents should now work as expected. Additionally, by reading the document's source from the `Document` maintained by `pygls` rather than reading from disk, document symbol requests are more accurate taking into account any unsaved changes in the user's editor. This also removes the need for direct file system access - poentially opening the door for running the vanilla docutils server in Pyodide?!
While the `language_id` patch is still unreleased and that we're still supporting Python 3.6 (for now) this backports the functionality into esbonio directly.
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.
As noted in #425, relying on a file's extension to determine whether its contents is a reStructuredText document or not is unreliable. Instead this switches the server over to checking the document's
language_idwhen it's available, but keeping the file extension checks as a fallback.