neild3r / php-docblock-checker
一个简单的工具,用于检查您的PHP类和方法是否使用了docblocks。
v1.13.3
2024-06-05 10:18 UTC
Requires
- php: >=7.3
- ext-json: *
- nikic/php-parser: 3.*|4.*
- symfony/console: 5.*|6.*
- symfony/yaml: 5.*|6.*
Requires (Dev)
- jakub-onderka/php-parallel-lint: 0.8.*
- phperf/xh-tool: ^1.1
- phpstan/phpstan: ^1.10.3
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.4
README
在目录内检查PHP文件的Docblocks使用情况。这是对原始作品@dancryer的分支,但仅添加了对新PHP特性的支持
安装
Composer
composer require neild3r/php-docblock-checker
用法
CMD
call vendor/bin/phpdoccheck {params}
验证上次git提交中更改的文件
git diff --name-only HEAD HEAD^ | ./vendor/bin/phpdoccheck --from-stdin
如果在一个travis环境中使用,这可能很有用
git diff --name-only ${TRAVIS_COMMIT_RANGE:-"HEAD^"} | ./vendor/bin/phpdoccheck --from-stdin
参数
参数可以从命令行或配置文件中传递(默认为当前工作目录下的phpdoccheck.yml
)。
可以通过指定--config-file
选项来覆盖配置文件的位置
如果两个地方都指定了参数,则命令行将具有优先权。
每个选项也可以在配置文件中使用
directory: src files-per-line: 10 cache-file: .phpdoccheck exclude: - foo/bar/baz.php - foo/* options: - skip-classes - skip-methods - skip-signatures - only-signatures - fail-on-warnings - info-only - from-stdin - json