eduarguz / shift-php-cs
PHP CS Fixer - Laravel 编码风格规则集
3.0.0
2021-12-07 13:51 UTC
Requires
- php: >=7.0
- friendsofphp/php-cs-fixer: ^3.0
This package is auto-updated.
Last update: 2024-09-07 20:10:03 UTC
README
本包允许您使用由 PHP CS Fixer 创建和推荐的规则集,该规则集由 Laravel Shift 推荐使用。
您可以在 此处 找到规则集的 原始和官方 源代码。
安装
您可以通过以下命令使用 composer 安装规则集:
composer require --dev eduarguz/shift-php-cs
此包还需要 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 eduarguz/shift-php-cs
重命名任何现有的文件
.php_cs
-> .php-cs-fixer.php
.php_cs.dist
-> .php-cs-fixer.dist.php
.php_cs.cache
-> .php-cs-fixer.cache
资源
- 在项目和团队间共享 PHP-CS-Fixer 规则。 Laravel 新闻文章
- Laravel Shift 推荐的编码规则集。 Gist - Shift