efureev / 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代码的规则。
安装
需要安装composer
,使用以下命令进行安装(如何安装composer 请参阅这里)。
$ composer require feugene/php-cs-fixer "^1.0"
安装
composer
是必需的
使用
在应用程序目录中,请在终端执行以下操作
$ php ./vendor/bin/cs-fix
您可以传递启动参数。如果传递--config
参数,则将忽略该包中定义的所有参数,并使用您提供的参数启动。
如果您需要可选地覆盖修复器规则参数,则请在应用程序根目录下创建一个名为.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许可协议许可。