bilberrry / php-docblock-checker
一个简单的工具,用于检查PHP类和方法是否使用了Docblocks。
1.10.3
2020-02-05 12:33 UTC
Requires
- php: >=5.5
- ext-json: *
- nikic/php-parser: 3.*|4.*
- symfony/console: >=3.3.10
- symfony/yaml: >=3.3.10
Requires (Dev)
- jakub-onderka/php-parallel-lint: 0.8.*
- phperf/xh-tool: ^1.1
- phpstan/phpstan: ^0.11.5
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ^3.4
README
检查目录内PHP文件的Docblocks使用情况。
安装
Composer:
composer require bilberrry/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