58 lines
1.8 KiB
Markdown
58 lines
1.8 KiB
Markdown
Tree-sitter Highlighting
|
|
=========================
|
|
|
|
[](https://travis-ci.org/tree-sitter/tree-sitter)
|
|
[](https://ci.appveyor.com/project/maxbrunsfeld/tree-sitter/branch/master)
|
|
[](https://crates.io/crates/tree-sitter-highlight)
|
|
|
|
### Usage
|
|
|
|
Compile some languages into your app, and declare them:
|
|
|
|
```rust
|
|
extern "C" tree_sitter_html();
|
|
extern "C" tree_sitter_javascript();
|
|
```
|
|
|
|
Load some *property sheets*:
|
|
|
|
```rust
|
|
use tree_sitter_highlight::load_property_sheet;
|
|
|
|
let javascript_property_sheet = load_property_sheet(
|
|
fs::read_to_string("./tree-sitter-javascript/src/highlights.json").unwrap()
|
|
).unwrap();
|
|
|
|
let html_property_sheet = load_property_sheet(
|
|
fs::read_to_string("./tree-sitter-html/src/highlights.json").unwrap()
|
|
).unwrap();
|
|
```
|
|
|
|
Highlight some code:
|
|
|
|
```rust
|
|
use tree_sitter_highlight::{highlight, HighlightEvent};
|
|
|
|
let highlights = highlight(
|
|
b"const x = new Y();",
|
|
unsafe { tree_sitter_javascript() },
|
|
&javascript_property_sheet,
|
|
&|_| None
|
|
).unwrap();
|
|
|
|
for event in highlights {
|
|
match event {
|
|
HighlightEvent::Source(s) {
|
|
eprintln!("source: {:?}", s);
|
|
},
|
|
HighlightEvent::ScopeStart(s) {
|
|
eprintln!("scope started: {:?}", s);
|
|
},
|
|
HighlightEvent::ScopeEnd(s) {
|
|
eprintln!("scope ended: {:?}", s);
|
|
},
|
|
}
|
|
}
|
|
```
|
|
|
|
The last parameter to `highlight` is a *language injection* callback. This allows other languages to be retrieved when Tree-sitter detects an embedded document (for example, a piece of JavaScript code inside of a `script` tag within HTML).
|