broadway / coding-standard
The coding standard of the Broadway project.
Installs: 26 675
Dependents: 24
Suggesters: 0
Security: 0
Stars: 3
Watchers: 6
Forks: 1
Open Issues: 1
Language:Makefile
Requires
- php: >=7.3
- friendsofphp/php-cs-fixer: ^3.0
- malukenho/docheader: ^0.1.7|1.0
This package is auto-updated.
Last update: 2024-10-17 14:52:20 UTC
README
The coding standard of the Broadway project.
Installation
$ composer require --dev broadway/coding-standard
Configuration
PHP CS fixer
- 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;
- add
.php_cs.cache
to your.gitignore
.
docheader
- copy the
.docheader.dist
template:
cp vendor/broadway/coding-standard/.docheader.dist ./.docheader
- modify the
.docheader
file is necessary.
Usage
$ vendor/bin/php-cs-fixer fix --allow-risky=yes --diff --verbose
$ vendor/bin/docheader check {src,test}