webimpress/coding-standard

Webimpress Coding Standard

Fund package maintenance!
michalbundyra

Installs: 1 001 808

Dependents: 30

Suggesters: 0

Security: 0

Stars: 13

Watchers: 4

Forks: 7

Open Issues: 6

Type:phpcodesniffer-standard

1.3.2 2023-12-18 07:25 UTC

This package is auto-updated.

Last update: 2024-05-18 08:16:31 UTC


README

Unit Tests Coding Standards 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 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