https://github.com/ProbablyClem/cargo-todo
Cargo tool to display TODOs
https://github.com/ProbablyClem/cargo-todo
Last synced: about 1 year ago
JSON representation
Cargo tool to display TODOs
- Host: GitHub
- URL: https://github.com/ProbablyClem/cargo-todo
- Owner: ProbablyClem
- Created: 2020-07-10T15:11:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T11:48:04.000Z (almost 2 years ago)
- Last Synced: 2025-05-04T03:47:05.849Z (about 1 year ago)
- Language: Rust
- Size: 16.5 MB
- Stars: 27
- Watchers: 0
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A tool to view every TODOs in the rust code
## Installation
```
$ cargo install cargo-todo
```
## Usage
you can add parameters to you TODOs
```
//todo 2001/11/01 5 !clement implement getters
```
The supported parameters are :
* Priority : A number between 1 and 9
* Deadline : A date format yyyy/mm/dd
* Member : A text that begin with '!'
* Content : Every text other thant the previouses will be considered as content
Those parameters can be added in any order as long as they follow the syntax they will be automaticaly added
### run
```rust
$cargo todo
src/main.rs line: 331 //todo
Member: clement
Priority: 5
Deadline: 2020-08-14
implement getters
```
### Default supported regex
* (?i)^\s*//\s*todo\b (//todo)
* (?i)^\s*//\s*fix\b (//fix)
* (?i)^\s*//\s*fixme\b (//fixme)
### cargo todo now support customizable regex
add all your customs regex in the ~/.cargo/todo_config file (will be created at launch)
## Features
* -i, --inline : display todo in one line
```rust
$cargo todo -i
src/main.rs line: 331 //todo Member: clement Priority: 5 Deadline: 2020-08-14 implement getters
```
* -v, --verbose : Sets the level of verbosity
default or -vv
full verbose
-v less verbose
```rust
$cargo todo -v
src/main.rs line: 331 //todo
implement getters
```
* -x, --exclude ... : Exclude some todos from the list
```rust
$cargo todo -x //fix
//wil display every todos expect those having the '//fix' keyword
```
* -f, --filter ... : Filter todos to show
```rust
$cargo todo -f //fix
//wil only display todos having the '//fix' keyword
```
* -l, --list : Number of values to display
```rust
$cargo todo -l 5
///wil display the first 5 todos
```
* m, --member ... : Filter from member
```rust
$cargo todo -m clement
///wil only display todos having as member clement
```
* -s, --sort : Sort todos [possible values: priority, deadline, member]
```rust
$cargo todo -s priority
///wil display todos sorted by their priority
```
## Legacy mode
### Can be used for legacy code base as it's support todo!() and unimplemented!()
### Will display every line with a supported token (listed below) and the inside of the macro
### /!\ Legacy mode is way slower the the default mode and lacks a lot of cool features
#### Example
code base
```rust
todo!("implement getters");
```
### run
```rust
$ cargo todo legacy
src/main.rs TODO Line 125 : implement getters
```
## Supported tokens
- //todo
- todo!()
- unimplemented!()
- fix
### /!\ WARNING
in legacy mode, cargo todo will no longer use regex but only the default tokens listed above