broadway/coding-standard

The coding standard of the Broadway project.

1.2.1 2022-08-22 11:51 UTC

Requires

• php: >=7.3
• friendsofphp/php-cs-fixer: ^3.0
• malukenho/docheader: ^0.1.7|1.0

MIT

• othillo

README

The coding standard of the Broadway project.

Installation

$ composer require --dev broadway/coding-standard

Configuration

PHP CS fixer

1. create a .php-cs-fixer.php file referencing the .php-cs-fixer.dist.php template:

# .php-cs-fixer.php

<?php

$config = require 'vendor/broadway/coding-standard/.php-cs-fixer.dist.php';

$config->setFinder(
    \PhpCsFixer\Finder::create()
        ->in([
            __DIR__ . '/src',
            __DIR__ . '/test',
        ])
);

return $config;

1. add .php_cs.cache to your .gitignore.

docheader

1. copy the .docheader.dist template:

cp vendor/broadway/coding-standard/.docheader.dist ./.docheader

1. modify the .docheader file is necessary.

Usage

$ vendor/bin/php-cs-fixer fix --allow-risky=yes --diff --verbose
$ vendor/bin/docheader check {src,test}