dowhatagain
| Crates.io | dowhatagain |
| lib.rs | dowhatagain |
| version | 0.1.3 |
| source | src |
| created_at | 2024-05-23 00:37:07.942336 |
| updated_at | 2024-05-31 18:49:01.512407 |
| description | Simple cli tool to extract todos from piped in files and output to various formats. |
| homepage | |
| repository | https://github.com/timonv/dowhatagain |
| max_upload_size | |
| id | 1248915 |
| size | 25,493 |
Timon Vonk (timonv)
documentation
README
Dowhatagain
Simple tool for filtering todos from a piped in list of files and outputting to various formats.
TODO comments in code have a tendency to be just left there yet they also have their value when building complicated things.
Installation
Manual:
- Clone the repository
- Install the rust toolchain
- Run
cargo install --path .
Via cargo:
cargo install dowhatagain
Features
- Output in Markdown and plain text
- Group by filename
- Simple display or detailed with filename and line number
- Way faster than needed using buffered parallel processing
Example usage
Get all TODOs in a repository:
$ fd . | dowhatagain
file1.rs:3: Do thing
file2.rs:4: Other thing
Get all TODOs for the current changeset and output to markdown:
git diff master --name-only | dowhatagain --output markdown --group-by file --detail just-task
file.rs
- [ ] Do thing
- [ ] Do other thing
other_file.rs
- [ ] Do thing
- [ ] Do other thing
Great for PR checks, commit hooks and custom workflows.