Highlight FIXME: and TODO: comments about nvim-treesitter HOT 30 CLOSED

You need to install the comment parser to get highlighting inside comments.

from nvim-treesitter.

I'll try to send a PR tomorrow or next week

from nvim-treesitter.

Hi and thanks for reporting this ! What you are aiming for here is what we call language injection, that is we want to treat certain parts of the program (the comments) differently.
We will build a comment (doc and codetags) later and use it together with language injection later. Unfortunately language injection is a bit tougher than expected.

from nvim-treesitter.

but maybe this something we can add by default? don't know how common is to use just TODO something instead of TODO: something

from nvim-treesitter.

Language injection is on by default now, only thing missing is creating the codetag parser, and setting things up for each language.
We are (still) missing some other things like a strip directive, that we will try to hack into here.

from nvim-treesitter.

@joellidin you need the @text.note highlight group.

from nvim-treesitter.

Are there some examples present to achieve this currently with treesitter? @vigoux

from nvim-treesitter.

@caheredia the syntax is TODO: something, you can highlight tokens that don't have : if you want with a custom query like

@stsewd according to python docs, https://www.python.org/dev/peps/pep-0350/#id25 it looks like Codetags should be followed by a colon. Although in the wild, I've seen more "TODO"s without the colon. Either way thanks for the custom query, I'll add that to my conifgs

from nvim-treesitter.

Damn, I didn't understand this 🤦‍♂️ Maybe it'll also help other people someday.
Sorry for the noise and thanks a lot for the help!

from nvim-treesitter.

I am sorry to yet again bring this up. But for python it still does not highlight the todo comments for me.

The healtcheck seems fine:

nvim-treesitter: require("nvim-treesitter.health").check()
========================================================================
## Installation
  - WARNING: `tree-sitter` executable not found (parser generator, only needed for :TSInstallFromGrammar, not required for :TSInstall)
  - OK: `node` found v14.20.0 (only needed for :TSInstallFromGrammar)
  - OK: `git` executable found.
  - OK: `cc` executable found. Selected from { vim.NIL, "cc", "gcc", "clang", "cl", "zig" }
    Version: cc (Ubuntu 11.3.0-1ubuntu1~22.04) 11.3.0
  - OK: Neovim was compiled with tree-sitter runtime ABI version 14 (required >=13). Parsers must be compatible with runtime ABI.

## Parser/Features H L F I J
  - go             ✓ ✓ ✓ ✓ ✓
  - bash           ✓ ✓ ✓ . ✓
  - cpp            ✓ ✓ ✓ ✓ ✓
  - cuda           ✓ ✓ ✓ ✓ ✓
  - regex          ✓ . . . .
  - graphql        ✓ . . ✓ ✓
  - markdown       ✓ . ✓ . ✓
  - make           ✓ . ✓ . ✓
  - python         ✓ ✓ ✓ ✓ ✓
  - rust           ✓ ✓ ✓ ✓ ✓
  - sql            ✓ . . . ✓
  - typescript     ✓ ✓ ✓ ✓ ✓
  - json           ✓ ✓ ✓ ✓ .
  - comment        ✓ . . . .
  - lua            ✓ ✓ ✓ ✓ ✓
  - dockerfile     ✓ . . . ✓
  - c              ✓ ✓ ✓ ✓ ✓
  - scss           ✓ . . ✓ .
  - vim            ✓ ✓ ✓ . ✓
  - toml           ✓ ✓ ✓ ✓ ✓
  - yaml           ✓ ✓ ✓ ✓ ✓
  - javascript     ✓ ✓ ✓ ✓ ✓
  - bibtex         ✓ . ✓ ✓ .
  - css            ✓ . ✓ ✓ ✓
  - latex          ✓ . ✓ . ✓
  - help           ✓ . . . .

from nvim-treesitter.

For those who still haven't figured out how to do that, just add the following to your lua config:
vim.api.nvim_set_hl(0, "@text.note", { link = "Search" })

Or you can use any word from :hi instead of "Search".

from nvim-treesitter.

Glad to hear it's on your roadmap already. This is in no way urgent, and I like that you're looking to do this in a generic fashion (which ultimately is what makes treesitter highlighting superior).

from nvim-treesitter.

Okay, language injection is here now ! Now what we need is a little parser to highlight such code tags, maybe a little code tag parser could be good !

from nvim-treesitter.

Sounds great. I regularly use the following:

• FIXME:, FIXME(username): (must be addressed)
• TODO:, TODO(username): (should be addressed)
• NYI: (not yet implemented)

from nvim-treesitter.

Awesome, it sounds like there was a PEP too specifying that a bit, maybe we can use that as a reference : https://www.python.org/dev/peps/pep-0350/

There is still some things to do to : for each language we'd have to set up injection, and use the strip!operator.

The problem is that the strip operator is not yet implemented and wouldn't word for now, so we need to find a proper way of doing so.

from nvim-treesitter.

I planned to do that with #590 So you could trim node ranges in the queries to get subranges of them.

from nvim-treesitter.

Likewise the lack of python TODO is a pain point for me as well. Glad it's on the roadmap.

from nvim-treesitter.

So, together with @steelsojka we've been discussing a bit.
There is some upstream issues that might block language injection a bit, and that we need to fix before going forward.

While this work is being done, I'll be working on the todo parser, and if anyone wants to contribute, I'll be really grateful.

from nvim-treesitter.

@vigoux I mostly code in python, but happy to help in any way I can

from nvim-treesitter.

@steelsojka did a a set of two PRs (neovim/neovim#13207, and #627) to be able to inject in a better way.

from nvim-treesitter.

An absolute MUST feature. See this PR neovim/neovim#13252

I work with files that are php -> js and php -> html -> js I could determine which of these parser chains to use based on filename. Have a spectacular syntax highlighting!

from nvim-treesitter.

Yes plssss

from nvim-treesitter.

I see this issue was recently closed, but TODO still isn't working for me in python

• OK: tree-sitter found 0.19.3(parser generator, used for :TSInstallFromGrammar)

• OK: git executable found.

• OK: cc executable found.

Parser/Features H L F I

• scala . . . .
• python ✓ ✓ ✓ ✓
• supercollider ✓ ✓ ✓ ✓
• go ✓ ✓ ✓ ✓
• haskell . . . .
• toml x x x x
• glimmer ✓ . . .
• ruby ✓ ✓ . ✓
• bash ✓ ✓ ✓ .
• vue ✓ . ✓ .
• php ✓ x ✓ .
• java ✓ ✓ . ✓
• svelte ✓ . ✓ ✓
• yaml ✓ ✓ ✓ ✓
• kotlin ✓ . . .
• nix ✓ ✓ ✓ .
• devicetree ✓ ✓ ✓ ✓
• html ✓ ✓ ✓ ✓
• dart x ✓ . ✓
• julia ✓ ✓ . .
• turtle ✓ ✓ ✓ ✓
• rst ✓ ✓ . .
• json ✓ ✓ ✓ ✓
• fennel x ✓ . .
• css x . ✓ ✓
• teal ✓ ✓ ✓ ✓
• erlang . . . .
• ocaml_interfacex ✓ ✓ .
• ql ✓ x . .
• javascript ✓ x ✓ ✓
• graphql ✓ . . ✓
• ocaml x ✓ ✓ .
• query ✓ ✓ ✓ ✓
• elm . . . .
• comment x . . .
• regex ✓ . . .
• c ✓ ✓ x x
• verilog x x x .
• jsdoc x . . .
• ocamllex x . . .
• jsonc x x x x
• swift . . . .
• sparql x x x x
• c_sharp x . . .
• cpp x x x x
• gdscript x x . .
• clojure x x . .
• typescript x x x x
• lua x x x x
• rust x x x x
• tsx x x x x
• ledger x . x x

from nvim-treesitter.

@caheredia the syntax is TODO: something, you can highlight tokens that don't have : if you want with a custom query like

("text" @text.warning
 (#match? @text.warning "^(TODO|HACK|WARNING)$"))

from nvim-treesitter.

I would highlight it without the : as well.

from nvim-treesitter.

Sorry to reactivate an old issue, but I never got my TODOs and FIXMEs highlighted in my neovim. Currently running 0.6.1, and I'm having the problem in two different languages, ruby and javascript. It's been like this for a while for me, and I was even surprised to find that it was supposed to work.

Healthcheck seems OK:

nvim_treesitter: health#nvim_treesitter#check
========================================================================
## Installation
  - OK: `tree-sitter` found 0.20.4 (parser generator, only needed for :TSInstallFromGrammar)
  - OK: `node` found v16.13.1 (only needed for :TSInstallFromGrammar)
  - OK: `git` executable found.
  - OK: `cc` executable found. Selected from { vim.NIL, "cc", "gcc", "clang", "cl", "zig" }
    Version: Apple clang version 12.0.5 (clang-1205.0.22.11)
  - OK: Neovim was compiled with tree-sitter runtime ABI version 13 (required >=13). Parsers must be compatible with runtime ABI.

## Parser/Features H L F I J
  - javascript     ✓ ✓ ✓ ✓ ✓ 
  - ruby           ✓ ✓ ✓ ✓ ✓ 

  Legend: H[ighlight], L[ocals], F[olds], I[ndents], In[j]ections
         +) multiple parsers found, only one will be used
         x) errors found in the query, try to run :TSUpdate {lang}

I don't know if color scheme can have an impact (like a non-implemented highlight group?), so I tried to switch and get the same result with nord, onedark, palenight, everforest and basically all decent color schemes I could think of.

Anything I may be missing? At this point I don't know how to investigate any further.

from nvim-treesitter.

You need to install the comment parser to get highlighting inside comments.

How I do that?

from nvim-treesitter.

Now I realized, I just added comment inside the ensure_installed list in my treesitter configuration.
Anyway, I think there are better solutions for this purpose: https://github.com/folke/todo-comments.nvim

from nvim-treesitter.

@joellidin I see that the : are highlighted, so this is probably your colorscheme missing highlighting the @text.* captures, see #2293 (comment)

from nvim-treesitter.

@joellidin I see that the : are highlighted, so this is probably your colorscheme missing highlighting the @text.* captures, see #2293 (comment)

@stsewd Thank you for the response. I looked and it seems that my colorscheme should have it. See picture below when I checked :hi. Worth noting maybe is that the todo comments get highlighted when I disable TS hightlighting. Is it anything obvious I am missing maybe?

from nvim-treesitter.