Git Product home page Git Product logo

vscode-parse-tree's Introduction

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. Run yarn compile, then 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 ~/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.

Updating web-tree-sitter

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:

  1. Update the variable TREE_SITTER_VERSION in the Makefile;
  2. Update the path to web-tree-sitter in package.json;
  3. (Optional) Create a new patch in patches/tree-sitter+$TREE_SITTER_VERSION.patch.

The script which builds our custom version is in the Makefile.

Change Log

See CHANGELOG.md.

Credits

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

vscode-parse-tree's People

Contributors

georgewfraser avatar pokey avatar connorshea avatar wenkokke avatar aaronjanse avatar ztlpn avatar andreasarvidsson avatar nathanheffley avatar linus-skold avatar scdf avatar will-sommers avatar dependabot[bot] avatar du-da avatar srijan-paul avatar sterlind avatar certainlach avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.