使用PHP CodeSniffer检查WordPress的编码规范，并在PhpStorm中进行检查和自动格式化

2 年 ago

韵, 科

1 minute

目前，我们对于项目的引进总结记录于2019年10月22日。

很久没有使用PHP CS（WordPressCS）了，最近我终于成功使用了composer进行安装。


$ composer require "squizlabs/php_codesniffer=*"
$ composer require wp-coding-standards/wpcs
$ ./vendor/bin/phpcs --config-set installed_paths "`pwd`/vendor/wp-coding-standards/wpcs"

首先

我在前日参加的2016年关西WordCamp上听了有关CI的演讲。
关于WordPress主题的CI和自动化有关的演讲非常精彩。我觉得很幸运去参加了这个WordCamp，感觉很棒。

GitHub和Travis CI可以测试、构建和自动化WordPress主题。
Megumi Hano是演讲者。

Word limit exceeded.

因为听了故事之后，我非常想试试，所以我试了试，但我本以为会很容易，结果却遇到了很多困难，所以做了一份操作指南。

WordPress的编码规约

WordPress有编码规范。
它涵盖 PHP、HTML、CSS、JavaScript等语言，主要决定了空格的使用、大括号的位置、宽度等等。
详细信息请参考官方网站。

WordPress 编码规范
https://wpdocs.osdn.jp/WordPress_编码规范

遵循编码规则来编写代码可以使其更易读。

PHP代码嗅探器

我们使用PHP Code Sniffer作为检查编码规范的工具。
要在macOS上安装，可以使用Homebrew或PEAR的方法，但这次我们选择了使用Composer进行全局安装。

$ composer global require "squizlabs/php_codesniffer=*"

如果 phpcs –version 可以运行，那么安装成功。

如果无法执行，请确认是否将路径添加到~/.composer/vendor/bin。

接下来，将安装适用于WordPress的编码规范。

$ git clone git@github.com:WordPress-Coding-Standards/WordPress-Coding-Standards.git \
~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/WordPress

安装完成后，将其注册到phpcs中。

$ phpcs --config-set installed_paths ~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/WordPress
Config value "installed_paths" added successfully

可以通过使用phpcs -i来确认已添加的内容。

$ phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend, WordPress, WordPress-Core, WordPress-Docs, WordPress-Extra and WordPress-VIP

由于WordPress用于编码规范调用的选项很长，因此最好注册一个别名。

$ alias wpcs="phpcs -p -s -v --standard=WordPress"

[PHP] 安装 PHP_CodeSniffer + WordPress-Coding-Standards
http://www.d-wood.com/blog/2014/09/12_6884.html

试着动一下

$ wpcs *.php

好多错误出来了！我会一边看着这个一边修正。

这就是以上的内容。

PhpStorm是一种强大的集成开发环境。

自动格式化

平时我使用PhpStorm，但是由于可以应用WordPress的编码规范，所以通常都是交给那边处理的。

PHPStorm上的WordPress编码规范配置
https://gist.github.com/Rarst/1370155

代码嗅探器 mǎ xiù qì)

让PhpStorm读取自定义的rulese.xml。

在上述章节中，我们已经可以对PHP CS本身进行指定。同时，我们需要让PhpStorm读取ruleset.xml文件。

从PhpStorm的选项界面中选择“编辑器>检查>PHP>PHP代码规范验证”。
在右侧的“编码标准”中选择“自定义”，然后按“…”按钮引用文件。
在这里加载每个项目的ruleset.xml文件。

将PHP代码规范器配置为PhpStorm检查

请参考以下网站

使用PHP_CodeSniffer来检查WordPress插件和主题是否符合编码标准。
或
尝试使用PHP CodeSniffer来检查是否遵守了编码规范。