todoit

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

Installation

• Cargo
• Nix/NixOS

Cargo

For cross-platform installation, todoit is on crates.io and can be installed using

cargo install todoit

Nix

todoit is in the NUR under nur.repos.ixhbinphoenix.todoit. This repository is also a flake!

Urgency

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

Usage

> 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
  -n, --num                Display urgency as a number instead of a long TODOO
  -h, --help               Print help
  -V, --version            Print version

Credits

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

License

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