Skip to content

cursorless-dev/vscode-parse-tree

Repository files navigation

Parse tree

Exposes an api function that can be used to get a parse tree for a given file.

Usage

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 { loadLanguage } = await parseTreeExtension.activate();

Don't forget to add an extensionDependencies-entry to package.json as described in https://code.visualstudio.com/api/references/vscode-api#extensions.

Contributing

Setup

  1. npm install

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 in tree-sitter-wasms
  2. Add a language to the map in languages.ts
  3. Add a reference to onLanguage:yourlang to the activationEvents section of package.json. yourlang must be a VSCode language identifier.
  4. Run npm install and npm run compile, then hit F5 in VSCode, with this project open, to test your changes.
  5. 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 ~/your/code/vscode-parse-tree ~/.vscode-server/extensions/parse-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

Syntax trees for VSCode using tree-sitter

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors