library code-quality

adeira/code-quality

Source of code quality rules for Adeira packages

Add those rules into playbook of your favorite CI server. You should create custom ruleset.xml with this content:, _(*1)

<?xml version="1.0"?>
<ruleset>
    <rule ref="./vendor/adeira/code-quality/ruleset.xml"/>
</ruleset>

For Travis (similar for Gitlab-CI):, _(*2)

before_script:
  - vendor/bin/parallel-lint . -e php,php3,php4,php5,phtml,phpt --exclude vendor --blame

script:
  - vendor/bin/tester tests -C
  - vendor/bin/phpcs --standard=ruleset.xml --extensions=php --encoding=utf-8 --tab-width=4 -sp app/ src/ --ignore=bootstrap.php
  - vendor/bin/phpcs --standard=ruleset.xml --extensions=php,phpt --encoding=utf-8 --tab-width=4 -sp tests/ --ignore=*/output/*,_temp/*,bootstrap.php

Complete Travis example:, _(*3)

language: php

php:
  - 7.0
  - 7.1

before_script:
  - composer selfupdate --no-progress
  - travis_retry composer install --prefer-dist
  - vendor/bin/parallel-lint . -e php,php3,php4,php5,phtml,phpt --exclude vendor --blame

script:
  - vendor/bin/tester tests -C
  - vendor/bin/phpcs --standard=ruleset.xml --extensions=php --encoding=utf-8 --tab-width=4 -sp src/ --ignore=bootstrap.php
  - vendor/bin/phpcs --standard=ruleset.xml --extensions=php,phpt --encoding=utf-8 --tab-width=4 -sp tests/ --ignore=*/output/*,_temp/*,bootstrap.php

notifications:
  email: false

Setup your favorite editor. In my case it's PhpStorm. First setup code sniffer:, _(*4)

, _(*5)

And then enable and setup rules for code sniffer:, _(*6)

, _(*7)