Add tree-sitter-comment (#1300)

* Add tree-sitter-comment

Fix #1164

* fix precedence in tree-sitter-comment highlights

connects https://github.com/helix-editor/helix/pull/1170

* set injection-regex for comment language

* remove comment filetype

* fix comment injections for neovim-style injections tags

* add comment injections for elixir

* remove f.comment

* fix spacing in .gitmodules

* run 'cargo xtask docgen'

Co-authored-by: Ivan Tham <pickfire@riseup.net>

.gitmodules

@@ -142,6 +142,10 @@
 	path = helix-syntax/languages/tree-sitter-perl
 	url = https://github.com/ganezdragon/tree-sitter-perl
 	shallow = true
+[submodule "helix-syntax/languages/tree-sitter-comment"]
+	path = helix-syntax/languages/tree-sitter-comment
+	url = https://github.com/stsewd/tree-sitter-comment
+	shallow = true
 [submodule "helix-syntax/languages/tree-sitter-wgsl"]
 	path = helix-syntax/languages/tree-sitter-wgsl
 	url = https://github.com/szebniok/tree-sitter-wgsl

book/src/generated/lang-support.md

@@ -4,6 +4,7 @@
 | c | ✓ |  |  | `clangd` |
 | c-sharp | ✓ |  |  |  |
 | cmake | ✓ |  |  | `cmake-language-server` |
+| comment | ✓ |  |  |  |
 | cpp | ✓ |  |  | `clangd` |
 | css | ✓ |  |  |  |
 | dart | ✓ |  | ✓ | `dart` |

helix-syntax/languages/tree-sitter-comment

@@ -0,0 +1 @@
+Subproject commit 5dd3c62f1bbe378b220fe16b317b85247898639e

languages.toml

@@ -406,6 +406,13 @@ shebangs = ["racket"]
 comment-token = ";"
 language-server = { command = "racket", args = ["-l", "racket-langserver"] }
 
+[[language]]
+name = "comment"
+scope = "scope.comment"
+roots = []
+file-types = []
+injection-regex = "comment"
+
 [[language]]
 name = "wgsl"
 scope = "source.wgsl"

runtime/queries/comment/highlights.scm

@@ -0,0 +1,30 @@
+[
+ "("
+ ")"
+] @punctuation.bracket
+
+":" @punctuation.delimiter
+
+((tag (name) @warning)
+ (#match? @warning "^(TODO|HACK|WARNING)$"))
+
+("text" @warning
+ (#match? @warning "^(TODO|HACK|WARNING)$"))
+
+((tag (name) @error)
+ (match? @error "^(FIXME|XXX|BUG)$"))
+
+("text" @error
+ (match? @error "^(FIXME|XXX|BUG)$"))
+
+(tag
+ (name) @ui.text
+ (user)? @constant)
+
+; Issue number (#123)
+("text" @constant.numeric
+ (#match? @constant.numeric "^#[0-9]+$"))
+
+; User mention (@user)
+("text" @tag
+ (#match? @tag "^[@][a-zA-Z0-9_-]+$"))

runtime/queries/elixir/injections.scm

@@ -0,0 +1,2 @@
+((comment) @injection.content
+ (#set! injection.language "comment"))

runtime/queries/glsl/injections.scm

@@ -1,3 +1,5 @@
-(preproc_arg) @glsl
+((preproc_arg) @injection.content
+ (#set! injection.language "glsl"))
 
-(comment) @comment
+((comment) @injection.content
+ (#set! injection.language "comment"))

runtime/queries/julia/injections.scm

@@ -1,5 +1,7 @@
 ; TODO: re-add when markdown is added.
-; ((triple_string) @markdown
-;   (#offset! @markdown 0 3 0 -3))
+; ((triple_string) @injection.content
+;  (#offset! @injection.content 0 3 0 -3)
+;  (#set! injection.language "markdown"))
 
-(comment) @comment
+((comment) @injection.content
+ (#set! injection.language "comment"))

runtime/queries/ledger/injections.scm

@@ -1,2 +1,2 @@
-(comment) @comment
-(note) @comment
+([(comment) (note)] @injection.content
+ (#set! injection.language "comment"))

runtime/queries/python/injections.scm

@@ -0,0 +1,2 @@
+((comment) @injection.content
+ (#set! injection.language "comment"))

runtime/queries/rust/injections.scm

@@ -1,3 +1,6 @@
+([(line_comment) (block_comment)] @injection.content
+ (#set! injection.language "comment"))
+
 ((macro_invocation
   (token_tree) @injection.content)
  (#set! injection.language "rust")

runtime/queries/svelte/injections.scm

@@ -26,5 +26,5 @@
   (#set! injection.language "typescript")
 )
 
-(comment) @comment
-
+((comment) @injection.content
+ (#set! injection.language "comment"))

runtime/queries/tsq/injections.scm

@@ -0,0 +1,2 @@
+((comment) @injection.content
+ (#set! injection.language "comment"))