您的位置:首页 > 编程语言 > PHP开发

使用 PHP-CS-Fixer 自动规范化你的 PHP 代码

2015-03-25 09:20 429 查看
良好的代码规范可以提高代码可读性,团队沟通维护成本。最推荐大家遵守的是 php-fig (PHP Framework Interop Group) 组织定义的 PSR-1 、 PSR-2 两个。不了解的同学可以先通过连接点击过去阅读下。

这篇文章主要介绍下两个工具让你的代码符合规范。

PHP-CS-Fixer

项目地址: https://github.com/FriendsOfPHP/PHP-CS-Fixer

使用效果可见今天 PHPHub 的一次 commit

通过安装 Composer 安装

composer.phar global require fabpot/php-cs-fixer


然后,确保 ~/.composer/vendor/bin 目录在你的 PATH 中。
export PATH="$PATH:$HOME/.composer/vendor/bin"


其他安装方法参考官方的 Installation

使用

使用 fix 指令修复文件夹或文件的代码风格
php php-cs-fixer.phar fix /path/to/dir
php php-cs-fixer.phar fix /path/to/file


使用 --level 选项设置修复至的「规范」。
php php-cs-fixer.phar fix /path/to/project --level=psr0
php php-cs-fixer.phar fix /path/to/project --level=psr1
php php-cs-fixer.phar fix /path/to/project --level=psr2
php php-cs-fixer.phar fix /path/to/project --level=symfony


更多使用方式参见 Usage

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

StyleCI

项目地址: https://github.com/StyleCI/StyleCI

官方网站: https://styleci.io/

StyleCI 是一个 Laravel5 项目,功能实现也是由 PHP-CS-Fixer 驱动。

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



这两个都是好工具,对于规范项目代码风格很有帮助,推荐给大家。写得不是很详细,勿怪 :smile:

本文来自:Linux教程网
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: