nolo 0.1.1

A CLI tool for discovering and analyzing `TODO` comments across codebases.
Documentation 
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

# `nolo` - a TODO comment suite

[![Built with Nix](https://img.shields.io/static/v1?label=built%20with&message=nix&color=5277C3&logo=nixos&style=flat-square&logoColor=ffffff)](https://builtwithnix.org)
[![Crates](https://img.shields.io/crates/v/nolo?style=flat-square)](https://crates.io/crates/nolo)
[![Matrix Chat Room](https://img.shields.io/badge/chat-on%20matrix-1d7e64?logo=matrix&style=flat-square)](https://matrix.to/#/#nolo:matrix.org)

A CLI tool for discovering and analyzing `TODO` comments across codebases.

## `$ nolo` - usage

`nolo` has the following cli interface:

<!-- `$ nix run . help` -->

```
A TODO comment suite

Usage: nolo [OPTIONS] [COMMAND]

Commands:
  scan    Scan for TODO comments
  report  Generate analytics report for TODO comments (default)
  help    Print this message or the help of the given subcommand(s)

Options:
      --config <CONFIG>  Path to configuration file
  -h, --help             Print help
  -V, --version          Print version
```

### `$ nolo report` - usage
<!-- `$ nix run . -- report --help` -->

```
Generate analytics report for TODO comments (default)

Usage: nolo report [OPTIONS] [PATH]

Arguments:
  [PATH]  Path to analyze for TODO comments

Options:
      --format <FORMAT>                Output format for the report [default: table] [possible values: table, json]
      --display-limit <DISPLAY_LIMIT>  Number of top files to display in report [default: 5]
      --config <CONFIG>                Path to configuration file
      --full-report                    Show all files with TODOs instead of limiting display
  -h, --help                           Print help
```

### `$ nolo scan` - usage
<!-- `$ nix run . -- scan --help` -->

```
Scan for TODO comments

Usage: nolo scan [OPTIONS] [PATH]

Arguments:
  [PATH]  Path to scan for TODO comments

Options:
      --config <CONFIG>  Path to configuration file
  -h, --help             Print help
```