linter-todo
Scans files for TODO-style keywords and reports them as linter messages
asiloisad 16 0 1.4.0 MIT GitHub

Services

This package provides:

This package consumes:

Dependencies

  • minimatch@^10.2.5

Keywords

  • linter
  • todo
  • fixme
  • hack
  • note
  • review
  • bug

  • Made for Pulsar!

    This package was written specifically for Pulsar and did not exist in the Atom package repository.

linter-todo

Scans files for TODO-style keywords and reports them as info-level linter messages. Uses the same default keywords as the built-in language-todo package.

Supports both regular source files and Jupyter notebooks (.ipynb). In notebook mode, each code cell is scanned individually and messages are mapped to the correct cell via jupyter-next.

Installation

To install linter-todo search for linter-todo in the Install pane of the Pulsar settings or run ppm install linter-todo. Alternatively, you can run ppm install asiloisad/pulsar-linter-todo to install a package directly from the GitHub repository.

Commands

Commands available in atom-workspace:

  • linter-todo:toggle-state: toggle config of linter state,
  • linter-todo:lint-projects: scan entire project for TODO keywords.
  • linter-todo:lint-selected: scan selected tree-view files or folders for TODO keywords.

Keywords

The following keywords are detected by default: TODO, FIXME, CHANGED, XXX, IDEA, HACK, NOTE, REVIEW, NB, BUG, QUESTION, COMBAK, TEMP, DEBUG, OPTIMIZE, WARNING.

Comment detection

Both scan modes restrict matches to comment regions only, consistent with the built-in language-todo package.

Editor scan uses Pulsar's tokenizer: a match is accepted only if its scope descriptor includes a comment scope or the file root is text.plain. This works for any language with a grammar loaded.

Project scan uses hardcoded comment syntax per file extension, since no tokenizer is available for files not open in the editor. Single-line and block comment markers are defined for all built-in extensions. Plain text files (.txt) are accepted in full. Files with no known comment syntax (e.g. .json, .md) produce no matches. Supported extensions: .c .cpp .h .hpp .cs .java .js .ts .jsx .tsx .vue .svelte .astro .html .css .scss .less .xml .py .ipy .rb .pl .pm .sh .bash .zsh .ps1 .bat .cmd .go .rs .swift .kt .dart .scala .hs .ml .el .clj .ex .exs .erl .yaml .yml .toml .cfg .ini .conf .sql .lua .r .m .tex .vim .coffee .cson .dat .gra .grb .txt.

Contributing

Got ideas to make this package better, found a bug, or want to help add new features? Just drop your thoughts on GitHub. Any feedback is welcome!