Lge_CodeSniffer/PHP_CodeSniffer的安装配置使用(Linux)

Lge_CodeSniffer是基于PHP_CodeSniffer的自定义编码规范检测脚本,编码规范基于PSR-2,对于少部分编写风格做了自定义调整,PSR-2 规范请参考:http://www.php-fig.org/psr/psr-2/,自定义Lge编码规范请参考PDF编码规范文件

本文是在Linux下配置PHP_CodeSniffer+Lge_CodeSniffer代码检测工具的介绍,如果是Windows下的配置,请参考我的另外一篇文章:Lge_CodeSniffer/PHP_CodeSniffer的安装配置使用(Windows)

一、编码检测工具的安装

既然基于PHP_CodeSniffer工具,那么首先我们需要安装PHP_CodeSniffer。

PHP_CodeSniffer有多种安装方式,并且官网首页即有说明:http://pear.php.net/package/PHP_CodeSniffer/

通过官网方式安装的PHP_CodeSniffer是最新版本,当前是 2.8.1

我当前的操作系统为 Ubuntu Desktop 14.04.4 LTS。

二、Lge_CodeSniffer的安装

Lge_CodeSniffer的开源项目地址位于:https://github.com/EngineQ/Lge_CodeSniffer,我们需要通过git下载检测脚本。我这里将脚本下载到我的主目录下:

下载完成后,我们需要将我们自定义的检测脚本加入到PHP_CodeSniffer检测工具当中。PHP_CodeSniffer的编码检测标准目录位于:

下面有很多默认的编码标准目录:

我们将Lge的标准加入进去,只需要创建一个软连接进去即可:

创建成功之后我们将会在PHP_CodeSniffer的标准目录看到一个软连接:

我们使用 phpcs -i 命令查看是否安装成功:

可以看到编码标准中新增了一个 Lge 标准,表示我们安装成功。

二、Lge_CodeSniffer的配置

安装成功之后,我们需要配置PHP_CodeSniffer默认使用我们自定义的编码规范,我们只需要执行以下两条命令即可:

如果执行失败并提示权限错误,请使用sudo执行,或者切换为root用户执行,执行完毕后查看当前的PHP_CodeSniffer配置:

表示我们配置成功了,从现在开始我们可以直接使用 phpcs 命令来检测我们的PHP文件的规范了。

二、phpcs命令的使用

首先我们创建一个PHP测试文件 test.php,内容如下:

接下来我们使用 phpcs 来检测这个文件内容是否符合编码规范:

可以看到我们这个测试文件有些编码规范问题,那么我们尝试着一个一个来解决它,最终修改之后的 test.php 文件内容:

对满足编码规范的PHP文件使用phpcs命令检测时,将会没有任何的错误输出信息:

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Leave a Reply

Your email address will not be published.