dancryer / php-docblock-checker
A simple tool for checking that your PHP classes and methods use docblocks.
Installs: 147 755
Dependents: 1
Suggesters: 0
Security: 0
Stars: 32
Watchers: 6
Forks: 38
Open Issues: 12
Requires
- php: >=5.5
- ext-json: *
- nikic/php-parser: 3.*|4.*
- symfony/console: 3.4.*|4.*
- symfony/yaml: 3.4.*|4.*
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
Check PHP files within a directory for appropriate use of Docblocks.
Installation
Composer:
composer require dancryer/php-docblock-checker
Usage
CMD:
call vendor/bin/phpdoccheck {params}
To validate changed files in the last git commit:
git diff --name-only HEAD HEAD^ | ./vendor/bin/phpdoccheck --from-stdin
If used within a travis context, this may be useful:
git diff --name-only ${TRAVIS_COMMIT_RANGE:-"HEAD^"} | ./vendor/bin/phpdoccheck --from-stdin
Parameters
Parameters may be passed either from the command line, or via a config file (defaults to phpdoccheck.yml
in the currrent working directory).
The config file location may be overriden by specifying the --config-file
option
If a parameter is specified in both places, the command line will take priority.
Each option is also available in the 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