kronostechnologies/php-coding-standard

Equisoft PHP coding standard

v2.0.0 2021-03-10 20:44 UTC

This package is auto-updated.

Last update: 2022-05-10 23:08:12 UTC


README

Linting with PHP Code Sniffer

  1. Install Code Sniffer: composer require --dev squizlabs/php_codesniffer
  2. Install the Equisoft ruleset: composer require --dev kronostechnologies/php-code-standard
  3. Add a phpcs.xml file at the root of your project:
    <?xml version="1.0"?>
    <ruleset>
        <rule ref="./vendor/kronostechnologies/php-coding-standard/phpcs.xml"/>
    </ruleset>
  4. Add an entry in your Makefile:
    check: phpcs
    
    phpcs:
    	./vendor/bin/phpcs --standard="./phpcs.xml" -p -s .
  5. Configure CircleCI with the phpcs Orb Orb

Building & Publishing

Apply your changes, merge in master branch, then execute the following commands from the root:

# Mirrors php-coding-standard repository in kronostechnologies/php-coding-standard
./bin/split.sh

# Push tag to kronostechnologies/php-coding-standard
./bin/release.sh v(MAJOR.MINOR.PATCH)

To get the latest tag without opening the php-coding-standard repository, checkout the file .tag.

Follow Semantic Versioning.

Afterwards, it is automatically published through packagist.