webimpress70/coding-standard

PHP 7.0 support for Webimpress Coding Standard

1.2.9 2022-04-14 21:21 UTC

Requires

• php: ^7.0 || ^8.0
• squizlabs/php_codesniffer: ^3.6.2

Requires (Dev)

• phpunit/phpunit: ^5.7.27 | ^9.5.20

Replaces

• webimpress/code-standard: *

BSD-2-Clause

• phpcs
• Coding Standard
• PSR-2
• php 7.0
• psr-12
• webimpress

README

[] (https://github.com/webimpress70/coding-standard/actions/workflows/phpunit.yml) [] (https://github.com/webimpress70/coding-standard/actions/workflows/phpcs.yml) [] (https://coveralls.io/github/webimpress70/coding-standard?branch=master)

Installation

1. Install the module via composer by running:

   $ composer require --dev webimpress70/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/webimpress70/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