README

Yii Code Style

A package that provides PHP CS Fixer rule sets for enforcing code style in Yii packages.

Requirements

• PHP 7.4 or higher.

Installation

The package could be installed with Composer:

composer require --dev yiisoft/code-style

General usage

The package contains the following sets of rules:

1. @Yiisoft/Core
2. @Yiisoft/Core:risky

An example configuration using these rule sets:

<?php

declare(strict_types=1);

use PhpCsFixer\Finder;
use Yiisoft\CodeStyle\ConfigBuilder;

$finder = (new Finder())->in([
    __DIR__ . '/src',
    __DIR__ . '/tests',
]);

return ConfigBuilder::build()
    ->setRiskyAllowed(true)
    ->setRules([
        '@Yiisoft/Core' => true,
        '@Yiisoft/Core:risky' => true,
    ])
    ->setFinder($finder);

Documentation

• Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Code Style is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates

Credits

The package is inspired by spiral/code-style repository.