ramsey / coding-standard
A common coding standard for Ramsey's PHP libraries.
Fund package maintenance!
ramsey
Installs: 2 450
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 3
Type:phpcodesniffer-standard
Requires
- php: ^7.4 || ^8
- dealerdirect/phpcodesniffer-composer-installer: ^0.7.0
- phpcsstandards/phpcsextra: ^1.0.0-alpha3
- phpcsstandards/phpcsutils: ^1.0.0-alpha3
- slevomat/coding-standard: ^6.3
- squizlabs/php_codesniffer: ^3.5
Requires (Dev)
- ext-dom: *
- captainhook/captainhook: ^5.3
- ergebnis/composer-normalize: ^2.6
- ramsey/conventional-commits: ^1.1
- sebastian/diff: ^4.0
This package is auto-updated.
Last update: 2021-02-20 16:16:09 UTC
README
A common coding standard for Ramsey's PHP libraries.
About
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.
Installation
Install this package as a dependency using Composer.
composer require --dev ramsey/coding-standard
Usage
To use this coding standard, add <rule ref="Ramsey"/>
to your phpcs.xml
configuration.
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:
./vendor/bin/phpcs
Contributing
Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.
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.