通过 
搜索
搜索k00ni / todolo
通过在终端上列出它们来跟踪你文件中的所有 TODO 项。
0.1.2
2020-08-07 13:58 UTC
Requires
- php: ^7.1
- ext-iconv: *
- symfony/console: ^4.4 || ^5.1
- symfony/polyfill-php80: ^1.18
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.16.3
- phpstan/phpstan: ^0.12.33
- phpunit/phpunit: ^7 || ^8 || ^9
This package is auto-updated.
Last update: 2024-09-18 21:18:30 UTC
README
关于
Todolo 帮助您跟踪文件中的 TODO、FIXME 等所有内容。它会在终端上显示所有相关 TODO 消息的文件列表。
我们遵循语义化版本控制 (https://semver.org/)，但直到我们达到 1.0.0 版本，仍然可能出现破坏性变更。升级说明将在 UPGRADE 文件中描述。
安装
请使用 composer 安装 k00ni/todolo。
用法
运行
在项目根目录下运行
vendor/bin/todolo。
如果您的 src 目录中的文件包含 TODO，例如
// TODO foobar
它可能在终端上打印出以下内容
-----------------------------------------------------
tests/Integration/TodoFinderTest.php
-----------------------------------------------------
- TODO 1
- FIXME 2
- Foobar
-----------------------------------------------------
tests/Integration/Helper/OutputHelperTest.php
-----------------------------------------------------
No TODOs found.
-----------------------------------------------------
配置
完整的配置示例
return [ 'dirs_to_check' => [ 'src', ], // show 'show_empty_dir' => false, 'show_files_with_no_todos' => false, 'show_no_files_info' => true, ];
dirs_to_check
列出您希望包含在 TODO 收集中的所有文件夹。
示例
return [ 'dirs_to_check' => [ 'src', ], ];
show_empty_dir
如果设置为 true，则将在后续的输出中显示空目录。
示例
return [ 'show_empty_dir' => true, ];
show_files_with_no_todos
如果设置为 true，则将显示没有 TODO 的文件。
示例
return [ 'show_files_with_no_todos' => true, ];
show_no_files_info
如果设置为 true，则将显示如果一个目录内没有文件的信息。
示例
return [ 'show_no_files_info' => true, ];