Skip to content

Commit

Permalink
basic README
Browse files Browse the repository at this point in the history
  • Loading branch information
gruhn committed Oct 7, 2024
1 parent 20801ef commit 2a0c211
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# tree-sitter-quint

Work in progress Tree Sitter grammar for [Quint](https://quint-lang.org/).
Mainly to get editor support in [Helix](https://helix-editor.com/).

To avoid tracking build artifacts in Git,
the generated parser is not included on the `master` branch.
Check the `release` branch instead.

## Example Helix Config (for now):

```toml
# languages.toml

[[language]]
comment-token = "//"
file-types = ["qnt"]
language-servers = ["quint-lsp"]
name = "quint"
scope = "source.quint"
block-comment-tokens = { start = "/*", end = "*/" }
tab-width = 2
unit = " "

[[grammar]]
name = "quint"
source = { git = "https://github.com/gruhn/tree-sitter-quint.git", rev = "release" }

[language-server.quint-lsp]
args = ["--stdio"]
command = "quint-language-server"
```

0 comments on commit 2a0c211

Please sign in to comment.