Download the PHP package exolnet/phpcs-config without Composer
On this page you can find all versions of the php package exolnet/phpcs-config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package phpcs-config
eXolnet - PHPCS Ruleset
A collection of shareable configurations for various coding-style tools to make the configurations consistent across our projects.
Setup
composer require --dev exolnet/phpcs-config
- Run the following command to run the standards checks:
You can add this to your Travis YAML file as a test:
Excluding Files
This standard includes special support for a .phpcsignore
file (in the future, this should be built into phpcs itself).
Simply place a .phpcsignore
file in your root directory (wherever you're going to run phpcs
from).
The format of this file is similar to .gitignore
and similar files: one pattern per line, comment lines should start with a #
, and whitespace-only lines are ignored:
Note that the patterns should match the PHP_CodeSniffer style: *
is translated to .*
for convenience, but all other characters work like a regular expression.
Patterns are relative to the directory that the .phpcsignore
file lives in. On load, they are translated to absolute patterns: e.g. */tests/*
in /your/dir/.phpcsignore
will become /your/dir/.*/tests/.*
as a regular expression. This differs from the regular PHP_CodeSniffer practice.
Advanced/Extending
If you want to add further rules (such as laravel-specific rules), you can create your own custom standard file (e.g. ruleset.xml
):
You can then reference this file when running phpcs:
Excluding/Disabling Checks
You can also customise the rule to exclude elements if they aren't applicable to the project:
Rules can also be disabled inline. phpcs rules can be disabled with a // @codingStandardsIgnoreLine
comment, and ESLint rules can be disabled with a /* eslint disable ... */
comment.
To find out what these codes are, specify -s
when running phpcs
, and the code will be output as well. You can specify a full code, or a partial one to disable groups of errors.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Alexandre D'Eschambeault
- Simon Gaudreau
- All Contributors
License
Copyright © eXolnet. All rights reserved.
This code is licensed under the MIT license. Please see the license file for more information.