fix(tree-sitter): pass node text to grammar #860
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
claytonrcarter
force-pushed
the
wasm-tree-sitter-compat
branch
from
df46adf to
47876e4
Compare
This fixes a subtle breaking change in the WASM tree-sitter modes that affected the semanticolor package. (And probably only that package.) Although the node text is unused in `idForScope` in the core editor, the legacy tree-sitter mode was specifically modified to pass the node text into `idForScope` so that the semanticolor package could make use of it to give custom scopes (and thus colors) to different symbols. (On activation, semanticolor monkey patches that method in relevant grammars.) This alone is not enough to get sematicolor working with Pulsar's new WASM tree-sitter modes, but it's one piece of the puzzle. Ref: 97b905a Ref: atom/atom#20212 Ref: https://github.com/pulsar-edit/pulsar/blob/1bf7fc4025f0b10623058e4e8340e166954ed188/src/tree-sitter-language-mode.js#L1321-L1324 Ref: https://github.com/digitallyserviced/semanticolor/blob/d219ef9a1f8fa5251025b74dc6dc0a7f7c38d102/lib/semanticolor-grammar.js#L44-L65
claytonrcarter
force-pushed
the
wasm-tree-sitter-compat
branch
from
47876e4 to
ae03e1e
Compare
|
I'm marking this ready for review because it's working for me locally. I'm pretty sure that the CI failure is just a flaky test because it's not related to anything I changed, only the macOS test is failing (ubuntu is passing) and it's a different failure that I got last time. 😆 |
savetheclocktower
approved these changes
Jan 18, 2024
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.
Identify the Bug
The WASM tree-sitter language mode does not pass node text into the grammar when calling
idForScope. This is a breaking change from the legacy tree-sitter language mode that prevents the semanticolor package from working with Pulsar's new tree-sitter modes. I believe that this only affects semanticolor, as the original change was made explicitly for that package. (See atom/atom#20212)References
idForScopeand makes use of the text: https://github.com/digitallyserviced/semanticolor/blob/master/lib/semanticolor-grammar.js#L44-L65Description of the Change
I updated
ScopeResolverandWASMTreeSitterLanguageModeto pass the syntax node text through toWASMTreeSitterGrammar. I also updatedWASMTreeSitterGrammarandTreeSitterGrammarto highlight why the seemingly unused parameter is needed. Once I identified what was needed, the change was easy.Alternate Designs
I looked around to see if there was a better way of getting the package working w/ the new mode, but didn't see anything obvious. Open to suggestions if there are other ways that I didn't see.
Possible Drawbacks
It is a little strange to make a change like this only to support a single package. That said, I love that package and I'm happy to be able to keep it going.
Verification Process
I did not add or update any tests, but I could attempt to do so if desired. I verified this by
semanticolorso that it recognizesWASMTreeSitterGrammars, in addition to legacy grammarsRelease Notes
Added support for the semanticolor package in modern tree-sitter grammars.