这篇文章主要介绍了php-cs-fixer编码格式化工具怎么用,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获、下面让小编带着大家一起了解一下。
php-cs-fixer - PHP编码格式化工具
php-cs-fixer是个代码格式化工具,格式化的标准是PSR-1, PSR-2以及一些symfony的标准。这个工具也和symfony,树枝等优秀的PHP库出自同门。
安装与更新
需要使用PHP 5.3.6以上的版本。
你可以直接下载封装好的phar包:php-cs-fixer。phar;
或者通过wget下载(下面的都是OSX和Linux上的用法):
wget http://get.sensiolabs.org/php-cs-fixer.phar -O php-cs-fixer
或者通过旋度下载:
curl http://get.sensiolabs.org/php-cs-fixer.phar -O php-cs-fixer
下载完成后给可执行的权限,然后移动到本目录下面即可:
sudo chmod + x php-cs-fixer sudo mv  php-cs-fixer /usr/地方/bin/php-cs-fixer
这样就可以在任何地方直接使用<代码> php-cs-fixer 代码>命令来调用了。
也可以用过作曲家来安装:
composer global require fabpot/php-cs-fixer
如果你是Mac用户,家酿用户并且已经挖掘过自制程序/php的话,也可以直接:
brew install php-cs-fixer
或者:
brew install 自制程序/php/php-cs-fixer
如果后续需要更新的话:
php-cs-fixer 由来
如果是通过家酿安装的:
brew upgrade php-cs-fixer
如果没有将执行文件放到本目录下或者在窗户需要使用php php-cs-fixer <代码>。phar 代码>代替<代码> php-cs-fixer> 代码。
用法
用法也很简单,最基本的命令参数就是<代码>修改> 代码,直接执行时会尽可能多的根据默认标准格式化代码:
#,格式化目录,如果是当前目录的话可以省略目录 php-cs-fixer fix /路径//dir #,格式化文件 php-cs-fixer.phar fix /道路//文件
<代码>——详细代码>选项用于展示应用了的规则,默认是文本(<代码> txt> 代码)格式。
<代码> 代码>——水平选项用于控制需要使用的规则层级:
php-cs-fixer fix /路径//project ——=psr0水平 php-cs-fixer fix /道路//project ——=psr1水平 php-cs-fixer fix /道路//project ——=psr2水平 php-cs-fixer fix /路径//project ——水平=symfony
默认情况下执行的是PSR-2的所有选项以及一些附加选项(主要是symfony相关的)。还有一些属于“贡献级别”的选项,你可以通过<代码>——调停者代码>选择性的添加,<代码>——调停者> 代码的多个条件要用逗号分开:
php-cs-fixer fix /路径//dir ——short_tag,调停者=换行缩进
如果有需要的话也可以使用<代码> -name_of_fixer 代码>采取黑名单的方式设定禁用哪些选项。如果同时设定了<代码>——调停者代码>和<代码> -name_of_fixer> 代码,前者的优先级更高。
同时使用<代码>——即将代码>和<代码> - diff 代码>命令可以显示出需要修改的汇总,但是并不实际修改。
通过以下方式也可以查看有哪些内容是会修改的,但是并不实际改动文件:
cat foo.php |, php-cs-fixer fix ——diff ——
自定义配置
<代码> - config> 代码选项可以用来设置选取目录以及文件进行分析并格式化,但是这个选项只能设置一些常见的已知的项目,比如symfony:
#,For 从而Symfony 2.3 +,分支 php-cs-fixer fix /路径//sf23 ——config=sf23
已有选项:
- <李>
默认默认配置
李> <李>线上购物线上购物项目
李> <李>sf23 symfony的项目
李>更多时候,我们可以通过配置文件来自定义格式化选项以及搜索的目录和文件。自定义配置通过在项目根目录添加一个<代码>。php_cs 代码>文件的方式实现。
设置本身就是PHP代码,最后返回一个Symfony \ CS \ ConfigInterface的实例即可。你可以设置格式化的选项,级别,文件以及目录。