ofbeaton/granite

Strict PHP Coding Style enforced by CodeSniffer 3.2+

granite-php

Opinionated coding style enforcement for PHP., _(*1)

Contains

We make use of the following programs: * PHP-Parallel-Lint * PHP_CodeSniffer, _(*2)

Installing via Composer

The recommended way to install granite-php is through Composer. Ensure you have it installed first., _(*3)

Next, run the Composer command to install the latest stable version:, _(*4)

composer require ofbeaton/granite-php
composer require squizlabs/php_codesniffer
composer require jakub-onderka/php-parallel-lint jakub-onderka/php-console-highlighter

Edit your composer.json and add or modify scripts section:, _(*5)

{
  ...

  "scripts": {
    "check": [
      "parallel-lint . --exclude vendor",
      "phpcs -p --standard=vendor/ofbeaton/granite-php/phpcs/granite --ignore=vendor src"      
    ],
    "fix": [
      "phpcbf -p --standard=vendor/ofbeaton/granite-php/phpcs/granite --ignore=vendor src"
    ],
    "check-tests": [
      "parallel-lint . --exclude vendor",
      "phpcs -p --standard=vendor/ofbeaton/granite-php/phpcs/granite-tests --ignore=vendor tests"      
    ],
    "fix-tests": [
      "phpcbf -p --standard=vendor/ofbeaton/granite-php/phpcs/granite-tests --ignore=vendor tests"
    ],
    "test": [
      "@check",
      "@check-tests"
    ]
  },

  ...
}

And update your project:, _(*6)

composer update ofbeaton/granite-php

After updating, you can now run granite-php:, _(*7)

composer test

Running granite-php on test suites

You usually want to relax some requirements for test suites, in that case run:, _(*8)

composer check-tests

Documentation

Please head over to the PHP page on the Granite wiki., _(*9)

License

This software is distributed under the MIT License. Please see License file for more information., _(*10)