webimpress70/coding-standard

PHP 7.0 support for Webimpress Coding Standard

Maintainers

Details

github.com/webimpress70/coding-standard

Source

Issues

Installs: 61

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 2

Type:phpcodesniffer-standard

pkg:composer/webimpress70/coding-standard

1.2.9 2022-04-14 21:21 UTC

Requires

Requires (Dev)

Replaces

  • webimpress/code-standard: *

BSD-2-Clause 5522017c8b6b806bd166f41f5b19ff1c28966fdb

phpcsCoding StandardPSR-2php 7.0psr-12webimpress

This package is auto-updated.

Last update: 2025-10-24 16:40:47 UTC

README

[Unit Tests] (https://github.com/webimpress70/coding-standard/actions/workflows/phpunit.yml) [Coding Standards] (https://github.com/webimpress70/coding-standard/actions/workflows/phpcs.yml) [Coverage Status] (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