feugene / php-cs-fixer
一个用于自动修复PHP代码格式的工具
v1.0.14
2019-03-30 09:07 UTC
Requires
- php: ^5.6 || >=7.0
- friendsofphp/php-cs-fixer: ^2.13
README
PHP的自动代码格式修复器
此包使用 composer
允许自动运行PHP代码格式的 Code Style Fixer
,使用一组固定的规则,这些规则被用作主要格式化原始 php
代码。
安装
使用以下命令通过composer安装此包
$ composer require feugene/php-cs-fixer "^1.0"
需要安装
composer
(如何安装composer)。
使用
在应用程序目录中,在终端中执行以下操作
$ php ./vendor/bin/cs-fix
您可以可选地传递自己的启动参数。在传递 --config
参数时,该包生成的所有参数都将被忽略,并将使用您提供的参数启动。
如果您需要可选地覆盖fixer的规则参数,则在应用程序根目录中创建一个名为 .cs_rules.php
的文件,返回一个规则关联数组(有关规则的详细信息,请参阅此链接)。如果存在,其内容将与包配置合并,可选地覆盖必要的规则。它应该具有以下形式
<?php /** * CS Fixer Rules. * * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer * @see https://mlocati.github.io/php-cs-fixer-configurator/ */ return [ '@PSR2' => true, '@PHP71Migration' => true, 'binary_operator_spaces' => [ 'operators' => [ '=' => 'align_single_space', '=>' => 'align_single_space', ], ], 'blank_line_after_namespace' => true, 'blank_line_after_opening_tag' => true, ];
您也可以在根目录放置一个名为 .cs_excludes.php
的文件,其中包含要排除处理路径的目录,形式如下
<?php /** * Excludes directories names. * * NOTE: excludes will works only for directories. */ return [ 'bootstrap', 'storage', 'vendor', 'public', 'resources', ];
要覆盖文件缓存路径,请设置环境变量 PHP_CS_FIX_CACHE_FILE_PATH
,其值为所需路径。例如
$ PHP_CS_FIX_CACHE_FILE_PATH=./.new.cache ./cs-fix
更多关于包的信息 - 查看源代码,卢克
。
更改日志
更改日志可以在这里找到。
支持
如果您在此包中找到任何错误,请在此存储库中创建问题。
许可
这是一个开源软件,根据MIT许可证授权。