README

PHP 编码标准修复工具可以帮助您在遵循 PSR-1 和 PSR-2 文档中定义的 PHP 编码标准以及更多标准时，修复代码中的大多数问题。

如果您已经使用 linter 来识别代码中的编码标准问题，您会知道手动修复它们是乏味的，尤其是在大型项目中。这个工具不仅可以检测它们，还可以为您修复它们。

以下是 PHP-CS-Fixer 的作者提供的介绍，这个包是一个用于在 Laravel 上通过 Artisan CLI 使用 PHP-CS-Fixer 的桥梁。从现在开始，您可以为每个 Laravel 项目使用不同的 PHP-CS-Fixer，而不是安装全局修复器，与您的团队一起轻松使用。

本包的特点

为每个 Laravel 项目使用不同的 PHP-CS-Fixer。
通过 Laravel Artisan CLI 运行 PHP-CS-Fixer 命令。
轻松导出修复器配置以设置或与团队共享。

概述

查看以下主题之一，以了解更多关于 Artisan PHP CS Fixer 的信息

Artisan PHP CS Fixer
本包的特点
概述

版本和兼容性

Artisan PHP CS Fixer 不支持 Laravel 4.x。目前，此包包含以下与 Laravel 5.x 及更高版本兼容的分支

注意：此文档适用于 3.x 分支

关于 3.x 版本的说明

如果您之前使用过此包，请参阅此处了解 3.x 中的更改

安装

您可以通过 Composer 安装此包。在 Laravel 应用程序目录的根目录下，运行以下命令（在任何终端客户端）

$ composer require jackiedo/artisan-php-cs-fixer

使用

获取版本

显示已安装的 PHP-CS-Fixer 版本。

语法

$ php artisan php-cs-fixer:version

修复代码

使用 PHP 编码标准修复您的代码。

语法

$ php artisan php-cs-fixer:fix [options] [path/to/dir/or/file]

示例

// Only shows which all files in your project would have been modified, leaving your files unchanged.
$ php artisan php-cs-fixer:fix --dry-run

// Really fixes all files in your project.
$ php artisan php-cs-fixer:fix

// Only fixes all files in the `app` directory
$ php artisan php-cs-fixer:fix app

// Only fixes all files in the `app` directory with specific configuration file
$ php artisan php-cs-fixer:fix --config="path/to/fixer-config/file" app

描述规则或规则集

显示规则或规则集的描述/用法。

语法

$ php artisan php-cs-fixer:describe name/of/rule/or/rule-set

示例 1

$ php artisan php-cs-fixer:describe @Symfony

示例 2

$ php artisan php-cs-fixer:describe array_syntax

配置

要更改修复器的配置以符合您自己的目的，您需要使用 artisan vendor:publish 命令发布配置文件，如下所示

$ php artisan vendor:publish --provider="Jackiedo\ArtisanPhpCsFixer\ArtisanPhpCsFixerServiceProvider"

这将在您的项目根目录中创建一个名为 .php-cs-fixer.php 的文件。此文件返回一个 PhpCsFixer\ConfigInterface 实例，允许您配置规则、需要分析的文件和目录。从现在开始，您可以与所有开发团队成员共享此文件。其余的取决于您，您需要考虑如何始终同步此文件以供团队使用。

排除缓存文件

每次您运行 artisan php-cs-fixer:fix 命令时，项目根目录下都会创建一个名为 .php-cs-fixer.cache 的文件。您可以通过将以下行追加到 .gitignore 文件来排除此文件

.php-cs-fixer.cache

许可证

PHP CS Fixer 官方文档

有关 PHP CS Fixer 的更多文档，您可以访问此处。

感谢使用

希望这个包对您有所帮助。

jackiedo / artisan-php-cs-fixer

维护者

详情