README

Opinionated coding style enforcement for PHP.

Contains

We make use of the following programs:

Installing via Composer

The recommended way to install granite-php is through Composer. Ensure you have it installed first.

Next, run the Composer command to install the latest stable version:

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:

{
  ...
  
  "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:

composer update ofbeaton/granite-php

After updating, you can now run granite-php:

composer test

Running granite-php on test suites

You usually want to relax some requirements for test suites, in that case run:

composer check-tests

Documentation

Please head over to the PHP page on the Granite wiki.

License

This software is distributed under the MIT License. Please see License file for more information.

ofbeaton / granite-php

Maintainers

Details