aloware/shift-php-cs

PHP CS Fixer - Laravel 编码风格规则集

dev-develop 2023-03-25 00:34 UTC

This package is auto-updated.

Last update: 2024-09-25 03:39:50 UTC


README

此包允许您使用由 PHP CS Fixer 创建和推荐的规则集,并进行了修改。

您可以在 此处 找到规则集的原始和官方源代码。

安装

您可以通过以下命令使用 composer 安装规则集:

composer require --dev aloware/shift-php-cs:dev-master

此包还需要 friendsofphp/php-cs-fixer 包的 ^3.0 版本。

使用方法

此包仅提供对推荐规则集的简单访问。仍然需要常见的和常规的 PHP-CS-Fixer 设置。

如果没有,请创建您的 .php-cs-fixer.php 文件。

touch .php-cs-fixer.php

将您的 Finder 配置放入其中。这将告诉 PHP-CS-Fixer 在哪里运行。

通常,对于 Laravel 项目,这是配置

<?php

use PhpCsFixer\Finder;

$project_path = getcwd();
$finder = Finder::create()
    ->in([
        $project_path . '/app',
        $project_path . '/config',
        $project_path . '/database',
        $project_path . '/resources',
        $project_path . '/routes',
        $project_path . '/tests',
    ])
    ->name('*.php')
    ->notName('*.blade.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true);

return \ShiftCS\styles($finder);

运行修复器。

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

在 CI 上运行

./vendor/bin/php-cs-fixer fix --dry-run

从 1.x 版本升级到 3.x 版本(到 PHP-CS-Fixer 3.x)

composer require --dev aloware/shift-php-cs:dev-master

重命名任何现有的文件

.php_cs -> .php-cs-fixer.php

.php_cs.dist -> .php-cs-fixer.dist.php

.php_cs.cache -> .php-cs-fixer.cache

资源