Download the PHP package block8/php-docblock-checker without Composer
On this page you can find all versions of the php package block8/php-docblock-checker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download block8/php-docblock-checker
More information about block8/php-docblock-checker
Files in block8/php-docblock-checker
Package php-docblock-checker
Short Description A simple tool for checking that your PHP classes and methods use docblocks.
License BSD-2-Clause
Homepage https://www.phptesting.org/
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-docblock-checker
PHP DocBlock Checker
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.
| Short | Long | Description |
|---|---|---|
| -h | --help | Display help message. |
| -x | --exclude=EXCLUDE | Files and directories (absolute or pattern) to exclude. |
| -d | --directory=DIRECTORY | Directory to scan. [default: "./"] |
| none | --cache-file=FILE | Use cache file to speed up processing. |
| none | --config-file=FILE | Use config file to specify options [default: "./phpdoccheck.yml"]. |
| none | --from-stdin | Use list of files provided via stdin |
| none | --skip-classes | Don't check classes for docblocks. |
| none | --skip-methods | Don't check methods for docblocks. |
| none | --skip-signatures | Don't check docblocks against method signatures. |
| none | --only-signatures | Only check methods that have parameters or returns. |
| -j | --json | Output JSON instead of a log. |
| -l | --files-per-line=FILES-PER-LINE | Number of files per line in progress [default: 50] |
| -w | --fail-on-warnings | Consider the check failed if any warnings are produced. |
| -i | --info-only | Information-only mode, just show summary. |
| -q | --quiet | Do not output any message. |
| -V | --version | Display this application version. |
| none | --ansi | Force ANSI output. |
| none | --no-ansi | Disable ANSI output. |
| -n | --no-interaction | Do not ask any interactive question. |
| -v -vv -vvv | --verbose | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug. |
Each option is also available in the config file:
All versions of php-docblock-checker with dependencies
nikic/php-parser Version 3.*|4.*
symfony/console Version 3.4.*|4.*
symfony/yaml Version 3.4.*|4.*
ext-json Version *