Recommend this page to a friend! |
Classes of milenmk | Simple PHP Password Manager | vendor/squizlabs/php_codesniffer/README.md | Download |
|
DownloadAboutPHP_CodeSniffer is a set of two PHP scripts; the main RequirementsPHP_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the Configuration Options manual page for a list of these requirements. If you're using PHP_CodeSniffer as part of a team, or you're running it on a CI server, you may want to configure your project's settings using a configuration file. InstallationThe easiest way to get started with PHP_CodeSniffer is to download the Phar files for each of the commands:
ComposerIf you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
Make sure you have the composer bin dir in your PATH. The default value is Or alternatively, include a dependency for
You will then be able to run PHP_CodeSniffer from the vendor bin directory:
PhiveIf you use Phive, you can install PHP_CodeSniffer as a project tool using the following commands:
You will then be able to run PHP_CodeSniffer from the tools directory:
PEARIf you use PEAR, you can install PHP_CodeSniffer using the PEAR installer. This will make the
Git CloneYou can also download the PHP_CodeSniffer source and run the
Getting StartedThe default coding standard used by PHP_CodeSniffer is the PEAR coding standard. To check a file against the PEAR coding standard, simply specify the file's location:
Or if you wish to check an entire directory you can specify the directory location instead of a file.
If you wish to check your code against the PSR-12 coding standard, use the
If PHP_CodeSniffer finds any coding standard errors, a report will be shown after running the command. Full usage information and example reports are available on the usage page. DocumentationThe documentation for PHP_CodeSniffer is available on the Github wiki. IssuesBug reports and feature requests can be submitted on the Github Issue Tracker. ContributingSee CONTRIBUTING.md for information. VersioningPHP_CodeSniffer uses a The The > NOTE: Backwards-compatible changes to the API used by sniff developers will allow an existing sniff to continue running without producing fatal errors but may not result in the sniff reporting the same errors as it did previously without changes being required. The > NOTE: As PHP_CodeSniffer exists to report and fix issues, most bugs are the result of coding standard errors being incorrectly reported or coding standard errors not being reported when they should be. This means that the messages produced by PHP_CodeSniffer, and the fixes it makes, are likely to be different between PATCH versions. |