Skip to content

Commit b2a96e6

Browse files
committed
basic README
1 parent 20801ef commit b2a96e6

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# tree-sitter-quint
2+
3+
Work in progress Tree Sitter grammar for [Quint](https://quint-lang.org/).
4+
Mainly to get editor support in [Helix](https://helix-editor.com/).
5+
6+
To avoid tracking build artifacts in Git,
7+
the generated parser is not included on the `master` branch.
8+
Check the `release` branch instead.
9+
10+
## Example Helix Config (for now):
11+
12+
```toml
13+
; languages.toml
14+
15+
[[language]]
16+
comment-token = "//"
17+
file-types = ["qnt"]
18+
language-servers = ["quint-lsp"]
19+
name = "quint"
20+
scope = "source.quint"
21+
block-comment-tokens = { start = "/*", end = "*/" }
22+
tab-width = 2
23+
unit = " "
24+
25+
[[grammar]]
26+
name = "quint"
27+
source = { git = "https://github.com/gruhn/tree-sitter-quint.git", rev = "release" }
28+
29+
[language-server.quint-lsp]
30+
args = ["--stdio"]
31+
command = "quint-language-server"
32+
```

0 commit comments

Comments
 (0)