spiral/code-style

Code style and static analysis tools rulesets collection

v2.1.2 2024-09-18 15:07 UTC

Requires

• php: >=8.1
• friendsofphp/php-cs-fixer: ^3.64

Requires (Dev)

• phpunit/phpunit: ^10.5
• spiral/dumper: ^3.3
• vimeo/psalm: ^5.26

MIT

• Aleksandr Novikov
• Aleksei Gagarin

README

This repository contains ruleset for PHP CS Fixer based on PER-2.

Installation and configuration

Install the package via composer:

composer require --dev spiral/code-style

Create a configuration file .php-cs-fixer.dist.php in the root of your project:

<?php declare(strict_types=1);

require_once 'vendor/autoload.php';

return \Spiral\CodeStyle\Builder::create()
    ->include(__DIR__ . '/src')
    ->include(__FILE__)
    ->build();

Feel free to adjust the paths to include/exclude files and directories.

Usage

To more convenient usage, you can add the following commands to the scripts section of the composer.json file:

{
    "scripts": {
        "cs:diff": "php-cs-fixer fix --dry-run -v --diff",
        "cs:fix": "php-cs-fixer fix -v"
    }
}

Now you can run the following commands:

composer cs:diff
composer cs:fix

CI integration

If you want to integrate code style check into CI, add the following step to your GitHub Actions configuration file:

on:
  push:
    branches:
      - '*'

name: Check Code Style

jobs:
  cs-check:
    uses: spiral/gh-actions/.github/workflows/cs.yml@master

If you want GitHub Actions to automatically fix the found errors, add the following step:

on:
  push:
    branches:
      - '*'

name: Fix Code Style

jobs:
  cs-fix:
    permissions:
      contents: write
    uses: spiral/gh-actions/.github/workflows/cs-fix.yml@master