webimpress/coding-standard

Webimpress Coding Standard

Maintainers

Details

github.com/webimpress/coding-standard

Source

Issues

Fund package maintenance!
michalbundyra

Installs: 1 278 448

Dependents: 29

Suggesters: 0

Security: 0

Stars: 13

Watchers: 4

Forks: 7

Open Issues: 7

Type:phpcodesniffer-standard

1.4.0 2024-10-16 06:55 UTC

Requires

Requires (Dev)

BSD-2-Clause 6f6a1a90bd9e18fc8bee0660dd1d1ce68cf9fc53

phpcsCoding StandardPSR-2psr-12webimpress

This package is auto-updated.

Last update: 2024-12-16 08:04:36 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