Code quality tools

Install composer deps in your project

composer require --dev squizlabs/php_codesniffer phpstan/phpstan

npm install eslint eslint-config-airbnb-base eslint-plugin-import --save-dev

Setup

• add project as git submodule relative (from gitlab) to your project

  git submodule add git@github.com:ezweb/code_quality.git code_quality
  

• you can also call hooks provided in your project

  # .hooks/pre-commit    
  php ./_code_quality/git-hooks/php-pre-commit.php
  

Configure/extend local phpcs configuration

• add/edit project phpcs.xml

  <?xml version="1.0"?>
  <ruleset>
      <description>Fusion</description>
      
      <config name="installed_paths" value="_code_quality/phpcs" />
      <rule ref="2LM"/>
    
      <!-- Override rule here -->
  </ruleset>

Configure gitlab-ci jobs

# .gitlab-ci.yml
phplint7:
    stage: lint
    image: php:7.3-alpine
    before_script:
        - apk add git
        - git submodule sync --recursive
        - git submodule update --init --recursive
    script:
        - ./_code_quality/phplint.sh

phpcs:
    stage: lint
    image: texthtml/phpcs:3.3.2
    before_script:
        - apk add git
        - git submodule sync --recursive
        - git submodule update --init --recursive
    script:
        - ./_code_quality/phpcs.sh