cargo-simple-todo
| Crates.io | cargo-simple-todo |
| lib.rs | cargo-simple-todo |
| version | 0.2.1 |
| source | src |
| created_at | 2022-07-16 01:09:28.936283 |
| updated_at | 2022-07-16 22:14:20.219556 |
| description | cargo-simple-todo, a simple cargo tool for checking todo(s) |
| homepage | |
| repository | https://github.com/DumbMahreeo/cargo-simple-todo |
| max_upload_size | |
| id | 626494 |
| size | 16,403 |
Max (callb4ck)
documentation
README
Cargo simple todo
Why
Because probablyclem/cargo-todo is a nice tool, but it does way too much for my taste.
How to use it
Install it with cargo install cargo-simple-todo.
Every todo must be inside a // comment and must start with either
@todo or @todo: (case insensitve)
Example todo comments:
// @todo: Do this thing
// @TodO do this weird thing
// Something @todo Do this
//@TODO : something else
Then execute cargo todo.
Try with cargo todo --help for further usage info.
Exit code
-
If any todos are found, exit code
1is returned to allow use in CI. -
For general errors, exit code
255is returned.
Thanks to orenbenkiki/cargo-todox for the inspiration on this one.
Warning
probablyclem/cargo-todo
and cargo-simple-todo conflict, so you can't keep them both installed
(they both use the cargo-todo bin name).