5 个不稳定版本
0.3.0 | 2022 年 10 月 12 日 |
---|---|
0.2.0 | 2022 年 7 月 23 日 |
0.1.2 | 2022 年 7 月 7 日 |
0.1.1 | 2022 年 7 月 7 日 |
0.1.0 | 2022 年 7 月 7 日 |
#2574 in 命令行实用工具
42KB
375 行
todo-ci
检查您的代码 TODO 项(如果逾期则失败 ci/cd)
快速入门
按照以下格式编写您的待办事项: @todo(YYYY-MM-DD): 一个待办事项的描述...
fn main() {
// @todo(2022-08-10): Print something besides "Hello World!"
println!("Hello World!");
print!("Hello World again!"); // @todo(2022-07-10): use `println` instead of `print`
}
运行 todo-ci
检查当前目录中过期的 TODO 项
# Local installation
todo-ci ./
# Docker
docker run -v $(pwd):/volume -it ghcr.io/aliadnani/todo-ci:latest /volume
用例
将 todo-ci
集成到您选择的 ci/cd 平台中,用于检查代码中的 TODO 项。如果发现任何逾期 TODO 项,则发出 1
退出代码,从而失败 ci/cd 运行。
安装
使用 cargo
cargo install todo-ci
使用 docker
# Pull the latest image
# See https://github.com/aliadnani/todo-ci/pkgs/container/todo-ci
docker pull ghcr.io/aliadnani/todo-ci:latest
功能
Options:
-n, --no-ignore
For disabling ignored files by default (.gitignore, hidden files, etc.)
-e, --no-error
For disabling returning system error code (1) if there are overdue todos
-d, --display-mode <DISPLAY_MODE>
Display mode:
- concise: total number of valid + overdue todos
- overdue-only: total number of valid + overdue todos + details of overdue todos
- default: total number of valid + overdue todos + details of all todos
[default: default] [possible values: concise, overdue-only, default]
-p, --pattern <IGNORE_PATTERN>
Pattern to check `todos` for (i.e. `*.rs` , `main.*`, etc.) [default: *]
-t, --timezone-offset <TIMEZONE_OFFSET>
Timezone to use for date checking [default: +00:00]
-h, --help
Print help information
-V, --version
Print version information
依赖
~10–21MB
~329K SLoC