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

Accurate syntax coloring for VSCode using tree-sitter
https://github.com/georgewfraser/vscode-tree-sitter

Last synced: 3 months ago
JSON representation

Accurate syntax coloring for VSCode using tree-sitter

• Host: GitHub
• URL: https://github.com/georgewfraser/vscode-tree-sitter
• Owner: georgewfraser
• License: mit
• Created: 2019-05-19T07:06:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T03:04:22.000Z (almost 2 years ago)
• Last Synced: 2024-07-22T02:22:46.176Z (4 months ago)
• Language: TypeScript
• Size: 7.26 MB
• Stars: 174
• Watchers: 6
• Forks: 26
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-tree-sitter - vscode-tree-sitter - sitter (Tools / Others)

README

        
# Tree Sitter for VSCode [Deprecated]

**With the improving support for custom syntax coloring through language server, this extension is no longer needed**

This extension gives VSCode support for [tree-sitter](http://tree-sitter.github.io/tree-sitter/) syntax coloring. Examples with tree-sitter coloring on the right:

## Go

![Go](./screenshots/go.png)

## Rust

![Rust](./screenshots/rust.png)

## C++

![C++](./screenshots/cpp.png)

## Ruby

![Ruby](./screenshots/ruby.png)

## Javascript / Typescript

![Typescript](./screenshots/typescript.png)

## Contributing

### Fixing colorization of an existing language

If you see something getting colored wrong, or something that should be colored but isn't, you can help! The simplest way to help is to create an issue with a simple example, a screenshot, and an explanation of what is wrong. 

You are also welcome to fix the problem yourself and submit a PR. Colorization is performed by the various `colorLanguage(x, editor)` functions in `src/colors.ts`. When working on the colorization rules, please keep in mind two core principles:

1. Good colorization is *consistent*. It's better to not color at all than to color inconsistently.

2. Good colorization is *selective*. The fewer things that we color, the more emphasis the color gives.

### Adding a new language

It's straightforward to add any [language with a tree-sitter grammar](https://tree-sitter.github.io/tree-sitter/).

1. Add a dependency on the npm package for that language: `npm install tree-sitter-yourlang`.

2. Add a color function to `./src/colors.ts`

3. Add a language to the dictionary at the top of `./src/extension.ts`

4. Add a **simplified** TextMate grammar to `./textmate/yourlang.tmLanguage.json`. The job of this textmate grammar is just to color keywords and simple literals; anything tricky should be left white and colored by your color function.

5. Add a reference to the grammar to the [contributes.grammars section of package.json](https://github.com/georgewfraser/vscode-tree-sitter/blob/fb4400b78481845c6a8497d079508d28aea25c19/package.json#L26). `yourlang` must be a [VSCode language identifier](https://code.visualstudio.com/docs/languages/identifiers).

6. Add a reference to `onLanguage:yourlang` to the [activationEvents section of package.json](https://github.com/georgewfraser/vscode-tree-sitter/blob/fb4400b78481845c6a8497d079508d28aea25c19/package.json#L18). `yourlang` must be a [VSCode language identifier](https://code.visualstudio.com/docs/languages/identifiers).

7. Add an example to `examples/yourlang`.

8. Hit `F5` in VSCode, with this project open, to test your changes.

9. Take a screenshot comparing before-and-after and add it to the above list.

10. Submit a PR!