README

PHP CS Fixer为M6Web组件配置。

安装

运行

$ composer require --dev m6web/php-cs-fixer-config

使用

配置

在项目的根目录下创建配置文件.php-cs-fixer.dist.php

<?php

$finder = PhpCsFixer\Finder::create()
    ->in(
        [
            __DIR__.'/src',
            __DIR__.'/tests',
        ]
    );

$config = new M6Web\CS\Config\BedrockStreaming();
$config->setFinder($finder);

return $config;

自定义配置

您可以扩展这些规则并应用自己的额外规则。

在项目的根目录下创建配置文件.php-cs-fixer.dist.php

<?php

$finder = PhpCsFixer\Finder::create()
    ->in([
        __DIR__.'/src',
        __DIR__.'/tests',
    ]);

$config = new class() extends PhpCsFixer\Config {
    public function __construct()
    {
        parent::__construct('customized Bedrock Streaming');
        $this->setRiskyAllowed(true);
    }
    
    public function getRules(): array
    {
        $rules = (new M6Web\CS\Config\BedrockStreaming())->getRules();
        
        // perform updates on the rules array here
        
        return $rules;
    }
};

$config->setFinder($finder);

return $config;

Git

将.php-cs-fixer.cache（这是由php-cs-fixer创建的缓存文件）添加到.gitignore

vendor/
.php-cs-fixer.cache

Makefile

创建包含以下目标的Makefile

# Coding Style

cs:
	./bin/php-cs-fixer fix --dry-run --stop-on-violation --diff

cs-fix:
	./bin/php-cs-fixer fix

cs-ci:
	./bin/php-cs-fixer fix --dry-run --using-cache=no --verbose

修复问题

手动

如果您需要在本地上检查问题，只需运行

$ make cs

如果您需要在本地上修复问题，只需运行

$ make cs-fix

在您的持续集成中运行

$ make cs-ci

鸣谢

由Bedrock Streaming开发，受refinery29/php-cs-fixer-config启发。

许可证

本项目采用MIT许可证。