Crates.io | todoit |
lib.rs | todoit |
version | 0.1.1 |
source | src |
created_at | 2023-10-03 19:05:40.756677 |
updated_at | 2023-10-04 22:45:23.462981 |
description | CLI Tool for showing all TODO's in a project |
homepage | https://git.ixhby.dev/ixhbinphoenix/todoit |
repository | https://git.ixhby.dev/ixhbinphoenix/todoit |
max_upload_size | |
id | 991446 |
size | 53,315 |
todoit is a simple cli tool that you can run in your codebase to list all TODO's that are in comments in your codebase.
Currently only single-line comments starting with "//" or "///" are supported
All todos in your codebase are sorted descending by urgency You can specify the urgency of your TODO's by simply adding O's to your TODO, like this
// TODO: This is an urgency 1 todo
// TODOOOOO: This is an urgency 5 todo
// TODO: This is another urgency 1 todo
Sample output:
./src/main.rs:13 TODOOOOO: This is an urgency 5 todo
./src/main.rs:12 TODO: This is an urgency 1 todo
./src/main.rs:14 TODO: THis is another urgency 1 todo
> todoit --help
CLI Tool for showing all TODO's in a project
Usage: todoit [OPTIONS] [DIR]
Arguments:
[DIR] Directory to list all TODO's from
Options:
-e, --exclude <EXCLUDE> Exclude file
--hidden Don't ignore hidden files
--ascending Sort todo's ascending by urgency instead of descending
-h, --help Print help
-V, --version Print version
This project is heavily inspired by snitch made by Tsoding. I made todoit because I found snitch a bit overkill for my use case and because I wanted to re-invent the wheel
This Project is licensed under the GPL-3.0, which can be found either here or on https://www.gnu.org/licenses/gpl-3.0.html