Download the PHP package chiron/coding-standard without Composer
On this page you can find all versions of the php package chiron/coding-standard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download chiron/coding-standard
More information about chiron/coding-standard
Files in chiron/coding-standard
Package coding-standard
Short Description A common coding standard for Chiron's PHP libraries.
License MIT
Informations about the package coding-standard
Chiron PHP Coding Standard
Chiron PHP Coding Standard based on PSR-12, Doctrine, and Slevomat Coding Standards
Table of Contents
- Introduction
- Install
- Usage
- Versioning
- Change Log
- Contributing
- Support
- Credits
- License
Introduction
This library provides the Chiron Coding Standard rules for PHP_CodeSniffer (phpcs
). It is inspired by and built upon
the Doctrine Coding Standard and the Slevomat Coding Standard.
Install
The only thing you need before getting started is Composer.
Install PHP Coding Standard:
To install the latest version of this library, run the command below:
The latest version of PHP Coding Standard requires PHP 7.1 at least.
Usage
Just add the default phpcs.xml.dist
file (it can be found in the root directory) to your project and you are ready to use
the Chiron Coding Standard when running phpcs
.
Advanced
If you need to suppress some errors, use the following tags in your php code.
Ignoring parts of a file
Ignoring files and folders
Versioning
This library follows SemVer with following rules.
Coding Standard document should be considered the source of truth and main object of SemVer.
MAJOR
version will be incremented if new rules are added to the document.MINOR
version will be incremented if new sniffs are implemented to check for existing described rules.PATCH
version will be incremented for bug fixing - fixing a bug is considered everything which does not conform to the document - this may even lead to (temporarily) disabling an existing sniff - or part of it, until a better check is available or it is properly fixed.
The implementation of the automatic checks (both custom sniffs and the ruleset.xml file) are not subject to the SemVer and may change over time to accommodate changes in PHP_CodeSniffer and provided default sniffs, which are used also by this standard.
Recommended dependency on this package is on MINOR
version (e.g. ~1.0.0
), which means effectively:
- No new rules will be added.
- New automatic checks may be added.
- You get fixes for existing automatic checks, or some of them may be disabled, if regressions are found.
Change Log
Please see CHANGELOG for more information on recent changes.
Contributing
Please see CONTRIBUTING for details.
Support
Please see SUPPORT for details.
Credits
- All Contributors
License
The MIT License (MIT). Please see the License File for more information.
All versions of coding-standard with dependencies
dealerdirect/phpcodesniffer-composer-installer Version ^0.7
slevomat/coding-standard Version ^7.0
squizlabs/php_codesniffer Version ^3.6