todolint identifies bugs based on code comments.
hackfixmetodo- etc.
Speakers are invited to submit pull requests to improve the writing in our examples.
$ cd examples
$ ls
en-us es-mx zh-cn zh-hk
$ cd en-us
$ todolint .
docs/backlog.txt:1:FIXME: Internationalize console messages.
greet.c:4:// TODO: Validate 1 < argc < 3
greet.c:8:// TODO
metrics.js:10:// hack: divide by zero
$ cd ../es-mx
$ todolint .
docs/backlog.txt:1:PTE: Internacionalizar los mensajes de la consola.
greet.c:8:// PTE: Validar 1 < argc < 3
greet.c:12:// PTE
metrics.js:10:// truco: dividir por cero"
$ cd ../zh-cn
$ todolint .
docs/backlog.txt:1:待办: 将控制台消息国际化为普通话。
greet.c:4:// 待办: 验证 1 < argc < 3
greet.c:8:// 待办
metrics.js:10:// 妙招: 零除
$ cd zh-hk
$ todolint .
docs/backlog.txt:1:待辦: 國際化控制台訊息。
greet.c:4:// 待辦: 驗證 1 < argc < 3
greet.c:8:// 待辦
metrics.js:10:// 妙招: 零除See CONFIGURATION.md for configuration file options.
Run todolint -h for CLI options.
todolint identifies software bugs, by searching codebases for mentions of unresolved TODO tasks.
Examples:
// todo: walk the dog
// todo
// walk the dogHowever, todolint allows comments that cite a URI-like resource, using the notation <status>: <uri>. The resource may provide a FAQ, ticketing system, or other documentation.
Exception:
// pending: https://doc.rust-lang.org/beta/rustc/platform-support.htmlThus, we now have a formal notation to track coding imperfections, including metadata about why the code may be stuck indefinitely in its current written state.
https://crates.io/crates/todolint
https://docs.rs/todolint/latest/todolint/
https://github.com/mcandre/todolint/releases
$ cargo install --force --path .(None)
For more details on developing todolint itself, see DEVELOPMENT.md.
BSD-2-Clause
- chandler normalizes tarballs
- kirill scans JSON documents
- linters curates many linters, SAST tools, and style guides
- nile normalizes ebooks
- slick scans POSIX shell scripts
- stank scans shell scripts
- unmake scans makefiles
✏️