todoit 0.1.4

CLI Tool for showing all TODO's in a project
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# 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](#Cargo)
- [Nix/NixOS](#NixOS)

#### Cargo

For cross-platform installation, todoit is on [crates.io](https://crates.io/crates/todoit) and can be installed using
```sh
cargo install todoit
```

#### NixOS

todoit is in the [NUR](https://github.com/nix-community/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
  -h, --help               Print help
  -V, --version            Print version
```

## Credits

This project is heavily inspired by [snitch](https://github.com/tsoding/snitch) made by [Tsoding](https://github.com/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](./LICENSE) or on [https://www.gnu.org/licenses/gpl-3.0.html](https://www.gnu.org/licenses/gpl-3.0.html)