README

This repository provides a default configuration used by all Netgen Layouts projects to check for coding standards violations. The config is based on PHP CS Fixer.

Installation

$ composer require --dev netgen/layouts-coding-standard

Usage

Create a .php-cs-fixer.php file in the root of your project with the following:

<?php

return new Netgen\Layouts\CodingStandard\PhpCsFixer\Config()
 ->setFinder(
 PhpCsFixer\Finder::create()
 ->exclude(['vendor'])
 ->in(__DIR__)
 )
;

Run the fixer with:

$ vendor/bin/php-cs-fixer fix

Overriding existing rules

You can override rules included in this config per project:

<?php

return new Netgen\Layouts\CodingStandard\PhpCsFixer\Config()
 ->addRules([
 'list_syntax' => ['syntax' => 'long'],
 ])
 ->setFinder(
 PhpCsFixer\Finder::create()
 ->exclude(['vendor'])
 ->in(__DIR__)
 )
;

Supporting PHAR distribution of PHP CS Fixer

You can also support running PHAR version of PHP CS Fixer by adding the following at the top of your .php-cs-fixer.php file:

// To support running PHP CS Fixer via PHAR file (e.g. in GitHub Actions)
require_once __DIR__ . '/vendor/netgen/layouts-coding-standard/lib/PhpCsFixer/Config.php';

This is e.g. useful if you wish to run PHP CS Fixer via GitHub action, which does not need running composer install:

# .github/workflows/coding_standards.yml
name: Coding standards
on: [push, pull_request]

jobs:
 php-cs-fixer:
 name: PHP CS Fixer
 runs-on: ubuntu-latest

 steps:
 - uses: actions/checkout@v6
 - uses: actions/checkout@v6
 with:
 repository: netgen-layouts/layouts-coding-standard
 path: vendor/netgen/layouts-coding-standard
 - name: PHP CS Fixer
 uses: docker://oskarstark/php-cs-fixer-ga
 with:
 args: --diff --dry-run

Check https://github.com/OskarStark/php-cs-fixer-ga for more details.