天天看点

PHP-CS-Fixer:格式化你的PHP代码

这个工具的作用就是按照 <code>psr-1</code> 和 <code>psr-2</code> 的规范格式化你的代码。

php需求:php最小版本5.3.6。

本地安装

安装很简单,下载php-cs-fixer.phar文件就行了。官方地址是:

<a href="http://get.sensiolabs.org/php-cs-fixer.phar">http://get.sensiolabs.org/php-cs-fixer.phar</a>

国内的朋友如果下载很慢,可以使用百度云:

composer方式安装

新建composer.json

运行:

稍等片刻,下载完成:目录生成了vendor文件夹。

设置全局:

注意,composer安装的与本地方式安装后调用的执行文件是不一样的。本地安装执行的是<code>php-cs-fixer.phar</code>;composer安装的执行的是<code>php vendor\fabpot\php-cs-fixer\php-cs-fixer</code>。

homebrew安装

命令行运行:

会给出很多帮助提示。

使用 fix 指令修复文件夹或文件的代码风格

选项:

示例:

有一些要注意的地方是,php-cs-fixer 因为是在不破坏相容性的前提下修正的,所以有些 <code>方法命名</code> 的规则就无法修。不过比起手动修正,可以省下不少时间。

在一些开源框架中都看到了 <code>.php_cs</code> 文件。这个文件便是php-cs-fixer的格式化配置。

官方是这么描述的:

如何使用<code>.php_cs</code>?

使用<code>--config-file</code>加载<code>.php_cs</code>文件。文件内容详情见文末。

或者

composer方式:

brew方式:

当我们使用 php-cs-fixer 让我们现有的代码规范化之后,我们怎么确保以后开发的代码,以及别人 pr 的代码都能正确的符合代码风格规范呢?

styleci 是一个 laravel5 项目,功能实现也是由 php-cs-fixer 驱动。

它可以自己分析你项目的 pull request,并且在你 merge 前显示出分析的结果。

该工具没有具体使用过,下面是它的官网,感兴趣的同学可以看看。

php coding standards fixer--friendsofphp

<a href="https://github.com/friendsofphp/php-cs-fixer">https://github.com/friendsofphp/php-cs-fixer</a>

使用 php-cs-fixer 自动规范化你的 php 代码_phphub - php &amp; laravel的中文社区

<a href="https://phphub.org/topics/547">https://phphub.org/topics/547</a>

现在写 php,你应该知道这些 - scholer 的 php 之路 - segmentfault

<a href="https://segmentfault.com/a/1190000003844380">https://segmentfault.com/a/1190000003844380</a>

basic php-cs-fixer rules

<a href="https://github.com/xiaoler/php-develop-standards/blob/master/php-cs-fixer-rules.md">https://github.com/xiaoler/php-develop-standards/blob/master/php-cs-fixer-rules.md</a>