Skip to content

tlaplus-community/vscode-parse-tree

 
 

Repository files navigation

Parse tree

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.

Contributing

Setup

  1. yarn
  2. Install emscripten for generating parser wasm files

Adding a new language

It's straightforward to add any language with a tree-sitter grammar.

  1. Add a dependency on the npm package for that language: yarn add -D tree-sitter-yourlang.
  2. Add a language to the dictionary at the top of ./src/extension.ts
  3. Add a reference to onLanguage:yourlang to the activationEvents section of package.json. yourlang must be a VSCode language identifier.
  4. Add your language to the top of the Makefile
  5. Hit F5 in VSCode, with this project open, to test your changes.
  6. Submit a PR!

Developing on WSL2

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-server extension 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 the vscode-server extension folder: ln -s ~/.vscode-server/extensions/vscode-parse-tree ~/git/vscode-pars-tree for instance.
  • If you get errors about needing to install the Remote-WSL extension, you might need to manually delete the extension from the host side and try again.

Change Log

See CHANGELOG.md.

Credits

Forked from https://github.com/georgewfraser/vscode-tree-sitter.

About

Accurate syntax coloring for VSCode using tree-sitter

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 83.3%
  • Shell 10.5%
  • Makefile 6.2%