A common coding standard for Ramsey's PHP libraries.
Fund package maintenance!
Installs: 30 908
Open Issues: 0
- php: ^8.1
- dealerdirect/phpcodesniffer-composer-installer: ^1.0
- phpcsstandards/phpcsextra: ^1.0
- slevomat/coding-standard: ^8.8
- squizlabs/php_codesniffer: ^3.7
- ext-dom: *
- captainhook/plugin-composer: ^5.3
- ergebnis/composer-normalize: ^2.30
- phpunit/phpunit: ^10.0
- ramsey/conventional-commits: ^1.3
- sebastian/diff: ^5.0
- spatie/phpunit-snapshot-assertions: ^5.0
A common coding standard for @ramsey's PHP libraries.
This is a custom coding standard for PHP_CodeSniffer. It borrows many sniffs from Slevomat Coding Standard and PHPCSExtra and combines them into a single unified, common standard for @ramsey's PHP libraries.
This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.
Install this package as a development dependency using Composer.
composer require --dev ramsey/coding-standard
To use this coding standard, add
<rule ref="Ramsey"/> to your
Here are the contents of an example
phpcs.xml.dist file that you may place in
the root of your repository:
<?xml version="1.0"?> <ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"> <arg name="extensions" value="php"/> <arg name="colors"/> <arg value="sp"/> <file>./src</file> <file>./tests</file> <rule ref="Ramsey"/> </ruleset>
Then, run PHP_CodeSniffer:
Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.
Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report.
Copyright and License
The ramsey/coding-standard library is copyright © Ben Ramsey and licensed for use under the terms of the MIT License (MIT). Please see LICENSE for more information.