Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gruhn committed Oct 15, 2024
1 parent 5c18e9e commit da6a06b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 29 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@ package-lock.json
build/
*.dylib
*.dylib.dSYM
*.so
*.so.dSYM
36 changes: 7 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,11 @@
# [WIP] tree-sitter-quint
# Tree Sitter Quint

Tree Sitter grammar for [Quint](https://quint-lang.org/).
Mainly with the goal to get editor support into [Helix](https://helix-editor.com/).
[Tree Sitter](https://tree-sitter.github.io/tree-sitter/)
grammar for
[Quint](https://quint-lang.org/).
Mainly with the goal to get editor support into
[Helix](https://helix-editor.com/).

To avoid tracking build artifacts in Git,
To avoid cluttering the repository with build artifacts,
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"
```
Also: download [helix-highlights.scm](https://github.com/gruhn/tree-sitter-quint/blob/release/queries/helix-highlights.scm) into your `<config-dir>/helix/runtime/queries/quint/highlights.scm`.

0 comments on commit da6a06b

Please sign in to comment.