agencenous/todo

用于检查项目中的 TODO 注释的 CLI 工具

维护者

详细信息

github.com/agencenous/todo

源代码

问题

安装: 81

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:项目

1.1.1 2024-09-24 09:26 UTC

GPL-3.0 35ca29174ccd307898bd2d3e6439b6aa3c9e132d

  • Bastien Ho

This package is auto-updated.

Last update: 2024-09-24 09:27:15 UTC

README

用于检查项目中的 TODO 注释的 CLI 工具

安装

composer require --dev agencenous/todo

用法

vendor/bin/todo

默认情况下，命令将在当前目录及其子目录中搜索格式为：php, js, css, scss, jsx 的文件中的 TODO: 注释。

默认情况下，一些目录被排除：vendor、node_modules、cache、.git。

您可以通过向命令传递参数来覆盖这些设置

vendor/bin/todo path/to/directory --formats=php,js,css,scss,jsx --exclude=vendor,node_modules,cache,.git

为了更方便的使用，您还可以在项目的根目录中创建一个配置文件 .todo.json

{
    "formats": ["php", "js", "css", "scss", "jsx"],
    "exclude": ["vendor", "node_modules", "cache", ".git"]
}

示例

vendor/bin/todo

输出（已着色）

./src/Controller/ApiController.php
- Line 422: "Apply pagination in query instead of post-processing"
./src/Front/components/DateView/index.js
- Line 7: "add format parameter to format the date"
./src/Helper/Apps/GoogleHelper.php
- Line 327: "Implete update event"
- Line 374: "Implete delete event"

 Found 4 TODOs

如果找到 TODO，则命令将退出状态码为 1，否则将退出状态码为 0。