Skip to content

szepeviktor/coding-standard-1

 
 

Repository files navigation

Webimpress Coding Standard

Build Status Coverage Status

Installation

  1. Install the module via composer by running:

    $ composer require --dev webimpress/coding-standard
  2. Add composer scripts into your composer.json:

    "scripts": { "cs-check": "phpcs", "cs-fix": "phpcbf" }
  3. Create file phpcs.xml on 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

About

Webimpress Coding Standard for PHP_CodeSniffer

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages

  • PHP 100.0%