webimpress / coding-standard
Webimpress Coding Standard
Fund package maintenance!
michalbundyra
Installs: 1 281 058
Dependents: 29
Suggesters: 0
Security: 0
Stars: 13
Watchers: 4
Forks: 7
Open Issues: 7
Type:phpcodesniffer-standard
Requires
- php: ^7.3 || ^8.0
- squizlabs/php_codesniffer: ^3.10.3
Requires (Dev)
- phpunit/phpunit: ^9.6.15
README
Installation
-
Install the module via composer by running:
$ composer require --dev webimpress/coding-standard
-
Add composer scripts into your
composer.json
:"scripts": { "cs-check": "phpcs", "cs-fix": "phpcbf" }
-
Create file
phpcs.xml
in base path of your repository with content:<?xml version="1.0"?> <ruleset name="Webimpress Coding Standard" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="./vendor/squizlabs/php_codesniffer/phpcs.xsd"> <rule ref="./vendor/webimpress/coding-standard/ruleset.xml"/> <!-- Paths to check --> <file>config</file> <file>src</file> <file>test</file> </ruleset>
As shown above you must define locations or files you want to be checked and fixed by code sniffer. For a reference please see: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset
Usage
-
To run checks only:
$ composer cs-check
-
To automatically fix many CS issues:
$ composer cs-fix