Add rainbow tree-sitter highlights

ref: helix-editor/helix#695 ref: helix-editor/helix#2857 Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
omentic · Nov 1, 2023 · eaf8d6d · eaf8d6d
1 parent 5c37120
commit eaf8d6d
Show file tree

Hide file tree

Showing 44 changed files with 1,453 additions and 266 deletions.
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -17,3 +17,4 @@
   - [Adding textobject queries](./guides/textobject.md)
   - [Adding indent queries](./guides/indent.md)
   - [Adding injection queries](./guides/injection.md)
+  - [Adding rainbow bracket queries](./guides/rainbow_bracket_queries.md)
diff --git a/book/src/configuration.md b/book/src/configuration.md
@@ -65,6 +65,7 @@ Its settings will be merged with the configuration directory `config.toml` and t
 | `workspace-lsp-roots` | Directories relative to the workspace root that are treated as LSP roots. Should only be set in `.helix/config.toml` | `[]` |
 | `default-line-ending` | The line ending to use for new documents. Can be `native`, `lf`, `crlf`, `ff`, `cr` or `nel`. `native` uses the platform's native line ending (`crlf` on Windows, otherwise `lf`). | `native` |
 | `insert-final-newline` | Whether to automatically insert a trailing line-ending on write if missing | `true` |
+| `rainbow-brackets` | Whether to render rainbow colors for matching brackets. Requires tree-sitter `rainbows.scm` queries for the language. | `false` |
 
 ### `[editor.statusline]` Section
 

diff --git a/book/src/generated/lang-support.md b/book/src/generated/lang-support.md
@@ -1,185 +1,185 @@
-| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Default LSP |
-| --- | --- | --- | --- | --- |
-| astro | ✓ |  |  |  |
-| awk | ✓ | ✓ |  | `awk-language-server` |
-| bash | ✓ | ✓ | ✓ | `bash-language-server` |
-| bass | ✓ |  |  | `bass` |
-| beancount | ✓ |  |  |  |
-| bibtex | ✓ |  |  | `texlab` |
-| bicep | ✓ |  |  | `bicep-langserver` |
-| blueprint | ✓ |  |  | `blueprint-compiler` |
-| c | ✓ | ✓ | ✓ | `clangd` |
-| c-sharp | ✓ | ✓ |  | `OmniSharp` |
-| cabal |  |  |  |  |
-| cairo | ✓ | ✓ | ✓ | `cairo-language-server` |
-| capnp | ✓ |  | ✓ |  |
-| clojure | ✓ |  |  | `clojure-lsp` |
-| cmake | ✓ | ✓ | ✓ | `cmake-language-server` |
-| comment | ✓ |  |  |  |
-| common-lisp | ✓ |  |  | `cl-lsp` |
-| cpon | ✓ |  | ✓ |  |
-| cpp | ✓ | ✓ | ✓ | `clangd` |
-| crystal | ✓ | ✓ |  | `crystalline` |
-| css | ✓ |  |  | `vscode-css-language-server` |
-| cue | ✓ |  |  | `cuelsp` |
-| d | ✓ | ✓ | ✓ | `serve-d` |
-| dart | ✓ |  | ✓ | `dart` |
-| devicetree | ✓ |  |  |  |
-| dhall | ✓ | ✓ |  | `dhall-lsp-server` |
-| diff | ✓ |  |  |  |
-| dockerfile | ✓ |  |  | `docker-langserver` |
-| dot | ✓ |  |  | `dot-language-server` |
-| dtd | ✓ |  |  |  |
-| edoc | ✓ |  |  |  |
-| eex | ✓ |  |  |  |
-| ejs | ✓ |  |  |  |
-| elixir | ✓ | ✓ | ✓ | `elixir-ls` |
-| elm | ✓ | ✓ |  | `elm-language-server` |
-| elvish | ✓ |  |  | `elvish` |
-| env | ✓ |  |  |  |
-| erb | ✓ |  |  |  |
-| erlang | ✓ | ✓ |  | `erlang_ls` |
-| esdl | ✓ |  |  |  |
-| fish | ✓ | ✓ | ✓ |  |
-| forth | ✓ |  |  | `forth-lsp` |
-| fortran | ✓ |  | ✓ | `fortls` |
-| fsharp | ✓ |  |  | `fsautocomplete` |
-| gas | ✓ | ✓ |  |  |
-| gdscript | ✓ | ✓ | ✓ |  |
-| gemini | ✓ |  |  |  |
-| git-attributes | ✓ |  |  |  |
-| git-commit | ✓ | ✓ |  |  |
-| git-config | ✓ |  |  |  |
-| git-ignore | ✓ |  |  |  |
-| git-rebase | ✓ |  |  |  |
-| gleam | ✓ | ✓ |  | `gleam` |
-| glsl | ✓ | ✓ | ✓ |  |
-| go | ✓ | ✓ | ✓ | `gopls` |
-| godot-resource | ✓ |  |  |  |
-| gomod | ✓ |  |  | `gopls` |
-| gotmpl | ✓ |  |  | `gopls` |
-| gowork | ✓ |  |  | `gopls` |
-| graphql | ✓ |  |  | `graphql-lsp` |
-| hare | ✓ |  |  |  |
-| haskell | ✓ | ✓ |  | `haskell-language-server-wrapper` |
-| haskell-persistent | ✓ |  |  |  |
-| hcl | ✓ |  | ✓ | `terraform-ls` |
-| heex | ✓ | ✓ |  | `elixir-ls` |
-| hosts | ✓ |  |  |  |
-| html | ✓ |  |  | `vscode-html-language-server` |
-| hurl | ✓ |  | ✓ |  |
-| idris |  |  |  | `idris2-lsp` |
-| iex | ✓ |  |  |  |
-| ini | ✓ |  |  |  |
-| java | ✓ | ✓ | ✓ | `jdtls` |
-| javascript | ✓ | ✓ | ✓ | `typescript-language-server` |
-| jinja | ✓ |  |  |  |
-| jsdoc | ✓ |  |  |  |
-| json | ✓ |  | ✓ | `vscode-json-language-server` |
-| json5 | ✓ |  |  |  |
-| jsonnet | ✓ |  |  | `jsonnet-language-server` |
-| jsx | ✓ | ✓ | ✓ | `typescript-language-server` |
-| julia | ✓ | ✓ | ✓ | `julia` |
-| just | ✓ | ✓ | ✓ |  |
-| kdl | ✓ |  |  |  |
-| kotlin | ✓ |  |  | `kotlin-language-server` |
-| latex | ✓ | ✓ |  | `texlab` |
-| lean | ✓ |  |  | `lean` |
-| ledger | ✓ |  |  |  |
-| llvm | ✓ | ✓ | ✓ |  |
-| llvm-mir | ✓ | ✓ | ✓ |  |
-| llvm-mir-yaml | ✓ |  | ✓ |  |
-| lua | ✓ | ✓ | ✓ | `lua-language-server` |
-| make | ✓ |  |  |  |
-| markdoc | ✓ |  |  | `markdoc-ls` |
-| markdown | ✓ |  |  | `marksman` |
-| markdown.inline | ✓ |  |  |  |
-| matlab | ✓ | ✓ | ✓ |  |
-| mermaid | ✓ |  |  |  |
-| meson | ✓ |  | ✓ |  |
-| mint |  |  |  | `mint` |
-| msbuild | ✓ |  | ✓ |  |
-| nasm | ✓ | ✓ |  |  |
-| nickel | ✓ |  | ✓ | `nls` |
-| nim | ✓ | ✓ | ✓ | `nimlangserver` |
-| nix | ✓ |  |  | `nil` |
-| nu | ✓ |  |  |  |
-| nunjucks | ✓ |  |  |  |
-| ocaml | ✓ |  | ✓ | `ocamllsp` |
-| ocaml-interface | ✓ |  |  | `ocamllsp` |
-| odin | ✓ |  | ✓ | `ols` |
-| opencl | ✓ | ✓ | ✓ | `clangd` |
-| openscad | ✓ |  |  | `openscad-lsp` |
-| org | ✓ |  |  |  |
-| pascal | ✓ | ✓ |  | `pasls` |
-| passwd | ✓ |  |  |  |
-| pem | ✓ |  |  |  |
-| perl | ✓ | ✓ | ✓ | `perlnavigator` |
-| php | ✓ | ✓ | ✓ | `intelephense` |
-| po | ✓ | ✓ |  |  |
-| pod | ✓ |  |  |  |
-| ponylang | ✓ | ✓ | ✓ |  |
-| prisma | ✓ |  |  | `prisma-language-server` |
-| prolog |  |  |  | `swipl` |
-| protobuf | ✓ |  | ✓ | `bufls`, `pb` |
-| prql | ✓ |  |  |  |
-| purescript | ✓ | ✓ |  | `purescript-language-server` |
-| python | ✓ | ✓ | ✓ | `pylsp` |
-| qml | ✓ |  | ✓ | `qmlls` |
-| r | ✓ |  |  | `R` |
-| racket | ✓ |  |  | `racket` |
-| regex | ✓ |  |  |  |
-| rego | ✓ |  |  | `regols` |
-| rescript | ✓ | ✓ |  | `rescript-language-server` |
-| rmarkdown | ✓ |  | ✓ | `R` |
-| robot | ✓ |  |  | `robotframework_ls` |
-| ron | ✓ |  | ✓ |  |
-| rst | ✓ |  |  |  |
-| ruby | ✓ | ✓ | ✓ | `solargraph` |
-| rust | ✓ | ✓ | ✓ | `rust-analyzer` |
-| sage | ✓ | ✓ |  |  |
-| scala | ✓ |  | ✓ | `metals` |
-| scheme | ✓ |  |  |  |
-| scss | ✓ |  |  | `vscode-css-language-server` |
-| slint | ✓ |  | ✓ | `slint-lsp` |
-| smithy | ✓ |  |  | `cs` |
-| sml | ✓ |  |  |  |
-| solidity | ✓ |  |  | `solc` |
-| sql | ✓ |  |  |  |
-| sshclientconfig | ✓ |  |  |  |
-| starlark | ✓ | ✓ |  |  |
-| strace | ✓ |  |  |  |
-| svelte | ✓ |  | ✓ | `svelteserver` |
-| sway | ✓ | ✓ | ✓ | `forc` |
-| swift | ✓ |  |  | `sourcekit-lsp` |
-| t32 | ✓ |  |  |  |
-| tablegen | ✓ | ✓ | ✓ |  |
-| task | ✓ |  |  |  |
-| templ | ✓ |  |  | `templ` |
-| tfvars | ✓ |  | ✓ | `terraform-ls` |
-| todotxt | ✓ |  |  |  |
-| toml | ✓ |  |  | `taplo` |
-| tsq | ✓ |  |  |  |
-| tsx | ✓ | ✓ | ✓ | `typescript-language-server` |
-| twig | ✓ |  |  |  |
-| typescript | ✓ | ✓ | ✓ | `typescript-language-server` |
-| ungrammar | ✓ |  |  |  |
-| unison | ✓ |  |  |  |
-| uxntal | ✓ |  |  |  |
-| v | ✓ | ✓ | ✓ | `v-analyzer` |
-| vala | ✓ |  |  | `vala-language-server` |
-| verilog | ✓ | ✓ |  | `svlangserver` |
-| vhdl | ✓ |  |  | `vhdl_ls` |
-| vhs | ✓ |  |  |  |
-| vue | ✓ |  |  | `vue-language-server` |
-| wast | ✓ |  |  |  |
-| wat | ✓ |  |  |  |
-| webc | ✓ |  |  |  |
-| wgsl | ✓ |  |  | `wgsl_analyzer` |
-| wit | ✓ |  | ✓ |  |
-| wren | ✓ | ✓ | ✓ |  |
-| xit | ✓ |  |  |  |
-| xml | ✓ |  | ✓ |  |
-| yaml | ✓ |  | ✓ | `yaml-language-server`, `ansible-language-server` |
-| yuck | ✓ |  |  |  |
-| zig | ✓ | ✓ | ✓ | `zls` |
+| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Rainbow Brackets | Default LSP |
+| --- | --- | --- | --- | --- | --- |
+| astro | ✓ |  |  |  |  |
+| awk | ✓ | ✓ |  |  | `awk-language-server` |
+| bash | ✓ | ✓ | ✓ | ✓ | `bash-language-server` |
+| bass | ✓ |  |  |  | `bass` |
+| beancount | ✓ |  |  |  |  |
+| bibtex | ✓ |  |  |  | `texlab` |
+| bicep | ✓ |  |  |  | `bicep-langserver` |
+| blueprint | ✓ |  |  |  | `blueprint-compiler` |
+| c | ✓ | ✓ | ✓ | ✓ | `clangd` |
+| c-sharp | ✓ | ✓ |  |  | `OmniSharp` |
+| cabal |  |  |  |  |  |
+| cairo | ✓ | ✓ | ✓ |  | `cairo-language-server` |
+| capnp | ✓ |  | ✓ |  |  |
+| clojure | ✓ |  |  | ✓ | `clojure-lsp` |
+| cmake | ✓ | ✓ | ✓ |  | `cmake-language-server` |
+| comment | ✓ |  |  |  |  |
+| common-lisp | ✓ |  |  | ✓ | `cl-lsp` |
+| cpon | ✓ |  | ✓ |  |  |
+| cpp | ✓ | ✓ | ✓ | ✓ | `clangd` |
+| crystal | ✓ | ✓ |  |  | `crystalline` |
+| css | ✓ |  |  | ✓ | `vscode-css-language-server` |
+| cue | ✓ |  |  |  | `cuelsp` |
+| d | ✓ | ✓ | ✓ |  | `serve-d` |
+| dart | ✓ |  | ✓ |  | `dart` |
+| devicetree | ✓ |  |  |  |  |
+| dhall | ✓ | ✓ |  |  | `dhall-lsp-server` |
+| diff | ✓ |  |  |  |  |
+| dockerfile | ✓ |  |  |  | `docker-langserver` |
+| dot | ✓ |  |  |  | `dot-language-server` |
+| dtd | ✓ |  |  |  |  |
+| edoc | ✓ |  |  |  |  |
+| eex | ✓ |  |  |  |  |
+| ejs | ✓ |  |  |  |  |
+| elixir | ✓ | ✓ | ✓ | ✓ | `elixir-ls` |
+| elm | ✓ | ✓ |  |  | `elm-language-server` |
+| elvish | ✓ |  |  |  | `elvish` |
+| env | ✓ |  |  |  |  |
+| erb | ✓ |  |  |  |  |
+| erlang | ✓ | ✓ |  | ✓ | `erlang_ls` |
+| esdl | ✓ |  |  |  |  |
+| fish | ✓ | ✓ | ✓ |  |  |
+| forth | ✓ |  |  |  | `forth-lsp` |
+| fortran | ✓ |  | ✓ |  | `fortls` |
+| fsharp | ✓ |  |  |  | `fsautocomplete` |
+| gas | ✓ | ✓ |  |  |  |
+| gdscript | ✓ | ✓ | ✓ |  |  |
+| gemini | ✓ |  |  |  |  |
+| git-attributes | ✓ |  |  |  |  |
+| git-commit | ✓ | ✓ |  |  |  |
+| git-config | ✓ |  |  |  |  |
+| git-ignore | ✓ |  |  |  |  |
+| git-rebase | ✓ |  |  |  |  |
+| gleam | ✓ | ✓ |  |  | `gleam` |
+| glsl | ✓ | ✓ | ✓ |  |  |
+| go | ✓ | ✓ | ✓ | ✓ | `gopls` |
+| godot-resource | ✓ |  |  |  |  |
+| gomod | ✓ |  |  |  | `gopls` |
+| gotmpl | ✓ |  |  |  | `gopls` |
+| gowork | ✓ |  |  |  | `gopls` |
+| graphql | ✓ |  |  |  | `graphql-lsp` |
+| hare | ✓ |  |  |  |  |
+| haskell | ✓ | ✓ |  |  | `haskell-language-server-wrapper` |
+| haskell-persistent | ✓ |  |  |  |  |
+| hcl | ✓ |  | ✓ |  | `terraform-ls` |
+| heex | ✓ | ✓ |  |  | `elixir-ls` |
+| hosts | ✓ |  |  |  |  |
+| html | ✓ |  |  | ✓ | `vscode-html-language-server` |
+| hurl | ✓ |  | ✓ |  |  |
+| idris |  |  |  |  | `idris2-lsp` |
+| iex | ✓ |  |  |  |  |
+| ini | ✓ |  |  |  |  |
+| java | ✓ | ✓ | ✓ | ✓ | `jdtls` |
+| javascript | ✓ | ✓ | ✓ | ✓ | `typescript-language-server` |
+| jinja | ✓ |  |  |  |  |
+| jsdoc | ✓ |  |  |  |  |
+| json | ✓ |  | ✓ | ✓ | `vscode-json-language-server` |
+| json5 | ✓ |  |  |  |  |
+| jsonnet | ✓ |  |  |  | `jsonnet-language-server` |
+| jsx | ✓ | ✓ | ✓ | ✓ | `typescript-language-server` |
+| julia | ✓ | ✓ | ✓ |  | `julia` |
+| just | ✓ | ✓ | ✓ |  |  |
+| kdl | ✓ |  |  |  |  |
+| kotlin | ✓ |  |  |  | `kotlin-language-server` |
+| latex | ✓ | ✓ |  |  | `texlab` |
+| lean | ✓ |  |  |  | `lean` |
+| ledger | ✓ |  |  |  |  |
+| llvm | ✓ | ✓ | ✓ |  |  |
+| llvm-mir | ✓ | ✓ | ✓ |  |  |
+| llvm-mir-yaml | ✓ |  | ✓ |  |  |
+| lua | ✓ | ✓ | ✓ |  | `lua-language-server` |
+| make | ✓ |  |  |  |  |
+| markdoc | ✓ |  |  |  | `markdoc-ls` |
+| markdown | ✓ |  |  |  | `marksman` |
+| markdown.inline | ✓ |  |  |  |  |
+| matlab | ✓ | ✓ | ✓ |  |  |
+| mermaid | ✓ |  |  |  |  |
+| meson | ✓ |  | ✓ |  |  |
+| mint |  |  |  |  | `mint` |
+| msbuild | ✓ |  | ✓ |  |  |
+| nasm | ✓ | ✓ |  |  |  |
+| nickel | ✓ |  | ✓ |  | `nls` |
+| nim | ✓ | ✓ | ✓ |  | `nimlangserver` |
+| nix | ✓ |  |  | ✓ | `nil` |
+| nu | ✓ |  |  |  |  |
+| nunjucks | ✓ |  |  |  |  |
+| ocaml | ✓ |  | ✓ |  | `ocamllsp` |
+| ocaml-interface | ✓ |  |  |  | `ocamllsp` |
+| odin | ✓ |  | ✓ |  | `ols` |
+| opencl | ✓ | ✓ | ✓ |  | `clangd` |
+| openscad | ✓ |  |  |  | `openscad-lsp` |
+| org | ✓ |  |  |  |  |
+| pascal | ✓ | ✓ |  |  | `pasls` |
+| passwd | ✓ |  |  |  |  |
+| pem | ✓ |  |  |  |  |
+| perl | ✓ | ✓ | ✓ |  | `perlnavigator` |
+| php | ✓ | ✓ | ✓ |  | `intelephense` |
+| po | ✓ | ✓ |  |  |  |
+| pod | ✓ |  |  |  |  |
+| ponylang | ✓ | ✓ | ✓ |  |  |
+| prisma | ✓ |  |  |  | `prisma-language-server` |
+| prolog |  |  |  |  | `swipl` |
+| protobuf | ✓ |  | ✓ |  | `bufls`, `pb` |
+| prql | ✓ |  |  |  |  |
+| purescript | ✓ | ✓ |  |  | `purescript-language-server` |
+| python | ✓ | ✓ | ✓ | ✓ | `pylsp` |
+| qml | ✓ |  | ✓ |  | `qmlls` |
+| r | ✓ |  |  |  | `R` |
+| racket | ✓ |  |  | ✓ | `racket` |
+| regex | ✓ |  |  | ✓ |  |
+| rego | ✓ |  |  |  | `regols` |
+| rescript | ✓ | ✓ |  |  | `rescript-language-server` |
+| rmarkdown | ✓ |  | ✓ |  | `R` |
+| robot | ✓ |  |  |  | `robotframework_ls` |
+| ron | ✓ |  | ✓ |  |  |
+| rst | ✓ |  |  |  |  |
+| ruby | ✓ | ✓ | ✓ | ✓ | `solargraph` |
+| rust | ✓ | ✓ | ✓ | ✓ | `rust-analyzer` |
+| sage | ✓ | ✓ |  |  |  |
+| scala | ✓ |  | ✓ |  | `metals` |
+| scheme | ✓ |  |  | ✓ |  |
+| scss | ✓ |  |  | ✓ | `vscode-css-language-server` |
+| slint | ✓ |  | ✓ |  | `slint-lsp` |
+| smithy | ✓ |  |  |  | `cs` |
+| sml | ✓ |  |  |  |  |
+| solidity | ✓ |  |  |  | `solc` |
+| sql | ✓ |  |  |  |  |
+| sshclientconfig | ✓ |  |  |  |  |
+| starlark | ✓ | ✓ |  | ✓ |  |
+| strace | ✓ |  |  |  |  |
+| svelte | ✓ |  | ✓ |  | `svelteserver` |
+| sway | ✓ | ✓ | ✓ |  | `forc` |
+| swift | ✓ |  |  |  | `sourcekit-lsp` |
+| t32 | ✓ |  |  |  |  |
+| tablegen | ✓ | ✓ | ✓ |  |  |
+| task | ✓ |  |  |  |  |
+| templ | ✓ |  |  |  | `templ` |
+| tfvars | ✓ |  | ✓ |  | `terraform-ls` |
+| todotxt | ✓ |  |  |  |  |
+| toml | ✓ |  |  | ✓ | `taplo` |
+| tsq | ✓ |  |  | ✓ |  |
+| tsx | ✓ | ✓ | ✓ | ✓ | `typescript-language-server` |
+| twig | ✓ |  |  |  |  |
+| typescript | ✓ | ✓ | ✓ | ✓ | `typescript-language-server` |
+| ungrammar | ✓ |  |  |  |  |
+| unison | ✓ |  |  |  |  |
+| uxntal | ✓ |  |  |  |  |
+| v | ✓ | ✓ | ✓ |  | `v-analyzer` |
+| vala | ✓ |  |  |  | `vala-language-server` |
+| verilog | ✓ | ✓ |  |  | `svlangserver` |
+| vhdl | ✓ |  |  |  | `vhdl_ls` |
+| vhs | ✓ |  |  |  |  |
+| vue | ✓ |  |  |  | `vue-language-server` |
+| wast | ✓ |  |  |  |  |
+| wat | ✓ |  |  |  |  |
+| webc | ✓ |  |  |  |  |
+| wgsl | ✓ |  |  |  | `wgsl_analyzer` |
+| wit | ✓ |  | ✓ |  |  |
+| wren | ✓ | ✓ | ✓ |  |  |
+| xit | ✓ |  |  |  |  |
+| xml | ✓ |  | ✓ | ✓ |  |
+| yaml | ✓ |  | ✓ | ✓ | `yaml-language-server`, `ansible-language-server` |
+| yuck | ✓ |  |  |  |  |
+| zig | ✓ | ✓ | ✓ | ✓ | `zls` |
diff --git a/book/src/guides/README.md b/book/src/guides/README.md
@@ -1,4 +1,4 @@
 # Guides
 
 This section contains guides for adding new language server configurations,
-tree-sitter grammars, textobject queries, and other similar items.
+tree-sitter grammars, textobject and rainbow bracket queries, and other similar items.