benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-01 11:06:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(comments)!: consolidate note captures

Browse source 
Distinguishing `hint` and `info` is too confusing; it's enough to have
`error`, `warning`, `todo`, and `note`.
This commit is contained in:
Christian Clason 2024-01-20 17:41:40 +01:00
parent 64b3d5e569
commit 5cc5627487
4 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -193,11 +193,10 @@ As languages differ quite a lot, here is a set of captures available to you when
@comment ; line and block comments
@comment.documentation ; comments documenting code
@comment.error ; error-type comments (e.g., `DEPRECATED:`)
@comment.warning ; warning-type comments (e.g., `WARNING:`, `FIX:`)
@comment.hint ; note-type comments (e.g., `NOTE:`)
@comment.info ; info-type comments
@comment.todo ; todo-type comments (e.g-, `TODO:`, `WIP:`)
@comment.error ; error-type comments (e.g. `ERROR`, `FIXME`, `DEPRECATED:`)
@comment.warning ; warning-type comments (e.g. `WARNING:`, `FIX:`, `HACK:`)
@comment.todo ; todo-type comments (e.g. `TODO:`, `WIP:`, `FIXME:`)
@comment.note ; note-type comments (e.g. `NOTE:`, `INFO:`, `XXX`)
```
#### Markup

4
queries/comment/highlights.scm
View file

@ -4,10 +4,10 @@
(user) @constant
")" @punctuation.bracket)?
":" @punctuation.delimiter)
(#any-of? @comment.todo "TODO" "WIP"))
(#any-of? @comment.todo "TODO" "WIP" "FIXME"))
("text" @comment.todo @nospell
(#any-of? @comment.todo "TODO" "WIP"))
(#any-of? @comment.todo "TODO" "WIP" "FIXME"))
((tag
(name) @comment.note @nospell

2
queries/gitcommit/highlights.scm
View file

@ -44,7 +44,7 @@
; (trailer (value) @none)
(breaking_change
(token) @comment.warning)
(token) @comment.error)
(breaking_change
(value) @none @spell)

4
queries/vimdoc/highlights.scm
View file

@ -48,8 +48,8 @@
(url) @string.special.url
((note) @comment.hint
(#any-of? @comment.hint "Note:" "NOTE:" "Notes:"))
((note) @comment.note
(#any-of? @comment.note "Note:" "NOTE:" "Notes:"))
((note) @comment.warning
(#any-of? @comment.warning "Warning:" "WARNING:"))