broadway/coding-standard

The coding standard of the Broadway project.

Maintainers

Details

github.com/broadway/coding-standard

Source

Issues

Installs: 26 775

Dependents: 24

Suggesters: 0

Security: 0

Stars: 3

Watchers: 6

Forks: 1

Open Issues: 1

Language:Makefile

1.2.1 2022-08-22 11:51 UTC

Requires

MIT 90094ef3d0dd879f50ac79005da5bea01e55f9a4

  • othillo <othillo.woop@othillo.nl>

This package is auto-updated.

Last update: 2024-11-17 14:58:15 UTC

README

The coding standard of the Broadway project.

build status

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}