README

Yii Code Style

A package that provides PHP CS Fixer rule sets and Rector rules 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

PHP CS Fixer

The package contains the following sets of rules:

@Yiisoft/Core
@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);

Rector

The package provides Rector rules:

RemoveOverrideAttributeRector — removes the #[Override] attribute from methods. Yii convention is not to use this attribute.

A ready-to-use SetList::YII_CORE set with rules recommended for Yii packages is also provided:

<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;
use Yiisoft\CodeStyle\Rector\SetList;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
        __DIR__ . '/tests',
    ])
    ->withSets([
        SetList::YII_CORE,
    ]);

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.

yiisoft / code-style

Maintainers

Package info

Fund package maintenance!

Statistics

Security