README.md

CI Test Tools

Installation

composer require --dev bamarni/composer-bin-plugin elbgoods/ci-test-tools

PHP

PHP-CS-FIXER

• tool: https://github.com/FriendsOfPHP/PHP-CS-Fixer
• config: configs/.php_cs.dist

Installation

composer bin php-cs require --dev friendsofphp/php-cs-fixer

Usage

vendor/bin/php-cs-test
vendor/bin/php-cs-fix

Configuration

If you want to adjust the default configuration you can use your composer.json[extra] section.

{
  "extra": {
    "php-cs-fixer": {
      "finder": {
        "include": [],
        "exclude": []
      }
    } 
  }
}

TLint

• tool: https://github.com/tightenco/tlint

Installation

composer bin php-tlint require --dev tightenco/tlint

Usage

vendor/bin/php-tlint-test

Configuration

You have to create a tlint.json file on your project root level with the following, and only, content.

{
    "preset": "laravel",
    "disabled": [
        "NoInlineVarDocs",
        "NoParensEmptyInstantiations"
    ]
}

PHPMD

• tool: https://github.com/phpmd/phpmd
• config: configs/phpmd.xml

Installation

composer bin php-md require --dev phpmd/phpmd

Usage

vendor/bin/php-md-test

PHP Insights

• tool: https://github.com/nunomaduro/phpinsights
• config: configs/phpinsights.php

Installation

composer bin php-insights require --dev nunomaduro/phpinsights

Usage

vendor/bin/php-insights-test

PHPMND

• tool: https://github.com/povils/phpmnd

Installation

composer bin php-mn require --dev povils/phpmnd

Usage

vendor/bin/php-mn-test

Larastan

• tool: https://github.com/nunomaduro/larastan
• config: configs/phpstan.neon.dist

Installation

composer bin php-stan require --dev nunomaduro/larastan

Usage

vendor/bin/php-stan-test

Configuration

You have to create a phpstan.neon.dist file on your project root level with the following content.

includes:
    - ./vendor-bin/php-stan/vendor/nunomaduro/larastan/extension.neon
    - ./vendor/elbgoods/ci-test-tools/configs/phpstan.neon.dist

parameters:
    paths:
        - ./app
        - ./config
        - ./routes