PHP工具篇:PHPStorm IDE使用CodeSniffer代码规范化管理

Jonathan Shieber 发布于2019-07-01 11:04 / 1904人阅读

摘要：使用进行代码规范化管理是一个优秀的代码风格检测工具定义了一系列的代码规范通常使用官方的代码规范标准，比如的能够检测出不符合代码规范的代码并发出警告或报错可设置报错等级常被用作团队开发时维护编码风格以及标准。

PHPStorm IDE使用CodeSniffer进行代码规范化管理

PHP_CodeSniffer是一个优秀的代码风格检测工具,定义了一系列的代码规范(通常使用官方的代码规范标准，比如PHP的PSR2),能够检测出不符合代码规范的代码并发出警告或报错(可设置报错等级),常被用作团队开发时维护编码风格以及标准。

安装

mac安装:

brew install php-code-sniffer
//检测安装是否成功
phpcs --h
//安装完成后的路径
/usr/local/Cellar/php-code-sniffer

phpcs的配置

查看详细配置。使用命令:phpcs --config-show

设置默认的编码标准。（这个很重要，建议使用 PSR2 的标准)

# 查看配置
$ phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz and Zend

# 设置编码标准为 PSR2
$ phpcs --config-set default_standard PSR2

隐藏警告。（当然，对于强迫症来说，警告都是不允许的，非强迫症患者可以使用此配置项）

# 隐藏警告提醒
$ phpcs --config-set show_warnings 0
# 开启警告提醒
$ phpcs --config-set show_warnings 1

显示检查进程。（如果项目需要检查的文件较多可以开启这个）

# 显示检查进程
$ phpcs --config-set show_progress 1
# 关闭进程显示
$ phpcs --config-set show_progress 0

显示颜色

# 显示颜色
$ phpcs --config-set colors 1
# 关闭颜色显示
$ phpcs --config-set colors 0

修改错误和警告等级

# 显示所有的错误和警告
$ phpcs --config-set severity 1
# 显示所有的错误，部分警告 注意等级可有从 5-8 5 的警告显示会更多，8 的更少
$ phpcs --config-set severity 1
$ phpcs --config-set warning_severity 5

设置默认编码

# 设置 utf-8
$ phpcs --config-set encoding utf-8

设置 tab 的宽度

# tab 为 4 个空格
$ phpcs --config-set tab_width 4
# 也可以对多带带文件生效
$ phpcs --tab-width=0 /path/to/code

代码验证

# 校验单个文件
$ phpcs filename
＃ 校验目录 注意这个时候别因为 linux 学的太好加个 -R 哈。
$ phpcs /path/dir

代码规范检测,命令行使用

$ phpcs /home/www/init.php
FILE: /home/www/init.php
-------------------------------------------------------------
FOUND 2 ERROR(S) AFFECTING 2 LINE(S)
-------------------------------------------------------------
  1 | ERROR | Extra newline found after the open tag
 13 | ERROR | Missing function doc comment
-------------------------------------------------------------

设置PHPStorm整合CodeSniffer

配置 Code Sniffer

在 “Preferences”->“Languages & Frameworks”->“PHP”->“Quality Tools” ->“Code Sniffer” 配置中，“Configuration” 项后点击...并输入 phpcs 路径，可以使用 “Validate” 按钮验证phpcs路径是否正确。

开启验证

在 “Preferences”->“Editor”->“Inspections”->“Quality Tools”配置中，勾选上 “PHP Code Sniffer validation”。

具体参数中,
Show warnings as: Warnning，标示提示级别
Coding standard PSR2 代表执行的规范如果找不到这个选项，点一下紧挨着的刷新按钮。

更多精彩内容，请关注作者博客，https://studytime.xin

专线服务 idc机房托管 PHP_CodeSniffer 本地代码管理工具 js ide 工具 ide开发工具

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/29808.html

PHP 规范说明与工具

摘要：今天这篇分享将简单地梳理一下规范，并介绍一个代码检查工具，结合以及进行实践。目前流行的一些规范是的简写，由组织制定的规范，是开发的实践标准。目前已表决通过了套标准，已经得到大部分框架的支持和认可。 > 作为一个新手，写出规范的代码也是一门必修课，除了阅读相应的代码规范文档之外，充分利用相关的工具能使得进阶之路事半功倍。今天这篇分享将简单地梳理一下 PHP 规范，并介绍一个代码检查工具 ...

snowLu 2019-06-28 13:49 评论0 收藏0
看吧，这就是现代化 PHP 该有的样子

摘要：这大概是我没有及早使用，或多数开发者流连现状造成的。它就是，一个的框架。行为驱动开发是来自测试驱动开发的开发过程。简单的说，它就是经常可能一天几次将小块代码整合进基础代码当中的行为。 showImg(https://segmentfault.com/img/remote/1460000013769815); 这是一篇社区协同翻译的文章，已完成翻译，更多信息请点击协同翻译介绍。文章...

Tangpj 2019-06-28 18:33 评论0 收藏0
PHP代码修正之CodeSniffer

摘要：它包含两类脚本，和地址脚本对文件定义了一系列的代码规范通常使用官方的代码规范标准，比如的，能够检测出不符合代码规范的代码并发出警告或报错可设置报错等级。脚本能自动修正代码格式上不符合规范的部分。 Last-Modified: 2019年5月10日13:59:27 参考链接 PHP开发规范之使用phpcbf脚本自动修正代码格式在PhpStorm中使用PSR2编码规范phpcbf脚本自...

khs1994 2019-07-01 12:45 评论0 收藏0
PHP IDE eclipse-php-luna 使用规范

摘要：前言根据调查大部分个人开发者会选择免费的基本上是和之争。团队协作时，初期还是需要有一个指导性质的工具规范，养成一至的代码风格。考虑用户较多，以下截图取自平台，平台基本一样。在统一编码习惯和风格后，并不限制编辑器。 PHP IDE eclipse-php-luna 前言根据http://www.sitepoint.com/best-php-ide-2014-survey-resul...

mgckid 2019-06-27 10:59 评论0 收藏0
使用PHPCS+GIT钩子保障团队开发中代码风格一致性实践

摘要：集成经过上面的操作，代码格式化的规则基本与的规则基本一致了，但也有一小部分不一致，所以后面还要用到和。一、背景笔者在6月份加入新团队，新团队这边刚组建起来，基础一些东西还处于待完善状态，比如笔者组内同学约定使用PSR-2的编码风格规范，但是并不是所有人都严格按照PSR-2来提交代码。最大的原因就是口头的约束力极为有限，而团队中大家使用的编辑器不统一，有使用phpstorm，也有使...

wums 2019-07-01 10:28 评论0 收藏0