Exposes an api function that can be used to get a parse tree node for a given file location. Can be used as follows:
const parseTreeExtension = vscode.extensions.getExtension("pokey.parse-tree");
if (parseTreeExtension == null) {
throw new Error("Depends on pokey.parse-tree extension");
}
const { getNodeAtLocation } = await parseTreeExtension.activate();Don't forget to add add an extensionDependencies-entry to package.json as
described in
https://code.visualstudio.com/api/references/vscode-api#extensions.
yarn- Install emscripten for generating parser wasm files
It's straightforward to add any language with a tree-sitter grammar.
- Add a dependency on the npm package for that language:
yarn add -D tree-sitter-yourlang. - Add a language to the dictionary at the top of
./src/extension.ts - Add a reference to
onLanguage:yourlangto the activationEvents section of package.json.yourlangmust be a VSCode language identifier. - Add your language to the top of the Makefile
- Run
yarn compile, then hitF5in VSCode, with this project open, to test your changes. - Submit a PR!
When working with WSL, the host vscode instance connects to a vscode server on the WSL vm. This happens automatically when you run "code" in WSL, as long as you have the "Remote - WSL" extension installed on the host. From there you need to:
- Install the
pokey.command-serverextension on the host vscode - Clone the extension in the WSL side.
- If you're adding language support to
vscode-parse-tree, you need to clone that as well, build it, and link it into thevscode-serverextension folder:ln -s ~/your/code/vscode-parse-tree ~/.vscode-server/extensions/parse-treefor instance. - If you get errors about needing to install the
Remote-WSLextension, you might need to manually delete the extension from the host side and try again.
We build a custom version of web-tree-sitter to ensure that we can always use the latest version and fix any problems as they come up.
To update web-tree-sitter:
- Update the variable
TREE_SITTER_VERSIONin theMakefile; - Update the path to
web-tree-sitterinpackage.json; - (Optional) Create a new patch in
patches/tree-sitter+$TREE_SITTER_VERSION.patch.
The script which builds our custom version is in the Makefile.
See CHANGELOG.md.
Forked from https://github.com/georgewfraser/vscode-tree-sitter.