nilportugues/php_todo

通过用户定义的待办短语列表检查代码,如果待办总数增加或超过阈值,则停止提交。

1.0.0 2015-11-10 00:04 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:52:52 UTC


README

Scrutinizer Code Quality SensioLabsInsight Latest Stable Version Total Downloads License Donate

原因

保持每个提交的 @todo 计数。

不允许提交如果 @todo 的总数增加或超过用户定义的阈值。

目的是保持 @todo 列表低,并强制清理代码或解决它们。

基于以下想法

安装

使用 Composer 安装包

$ composer require --dev nilportugues/php_todo

使用方法

非常简单

$ php bin/php_todo find <path/to/directory>

配置文件

  • 定义代码中要查找的待办注释。
  • 定义可容忍的 @todo 数量。

首次运行时,如果找不到 php_todo_finder.yml 文件,您需要创建它。

例如,配置应格式如下

todo_finder:
  total_allowed: 5
  expressions:
    - @todo
    - TODO
    - refactor
    - FIX ME

您可以通过传递 -c 参数指定配置文件的替代位置。例如

$  php bin/php_todo find -c configs/php_todo_finder.yml src/

贡献

欢迎对包的贡献!

支持

使用以下方式之一与我联系

作者

许可证

代码库在 MIT 许可证 下授权。