WordPress 编码标准 – phpcs 警告
WordPress Coding Standards – phpcs Warnings
我正在为我刚在 PhpStorm 中开始的项目使用 WordPress-Core 规则(涉及开发自定义插件和主题),我发现大多数默认 php 文件很奇怪在干净的 WordPress 安装中(例如,wp-config.php、wp-mail.php 等)当该 repo 中的任何 WordPress 规则是使用过。
大多数时候我看到左括号和右括号警告:
PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket
PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket
存储库中的 WordPress 核心规则集说:
<rule ref="PEAR.Functions.FunctionCallSignature">
<properties>
<property name="requiredSpacesAfterOpen" value="1"/>
<property name="requiredSpacesBeforeClose" value="1"/>
</properties>
</rule>
这让我觉得警告是合法的(?)。如果是这样,为什么WP核心文件没有完全遵循WP自己的代码标准呢?
从历史上看,WordPress 避免清理核心代码样式,原因如下:
- 检查编码标准的工具不是特别可靠。近年来,随着 WordPress 编码标准 (WPCS) 项目的成熟,许多小的边缘案例在 PHPCS 中得到修复。
- 没有可靠的自动化工具,这将是一项手动工作,需要多次提交。这会导致不必要的代码改动,并使查看修订日志变得更加困难。
- 它只是没有被高度重视。 ~4% 的 WordPress PHP 违反了编码标准,所以大多数人不会遇到它。
随着工具的成熟,这一立场最近发生了变化,现在有一个 in-progress effort 可以让 PHPCS 和 WPCS 与 WordPress 核心一起工作。通过适当的自动化测试,WordPress 将在未来继续匹配其自己的编码标准。
我正在为我刚在 PhpStorm 中开始的项目使用 WordPress-Core 规则(涉及开发自定义插件和主题),我发现大多数默认 php 文件很奇怪在干净的 WordPress 安装中(例如,wp-config.php、wp-mail.php 等)当该 repo 中的任何 WordPress 规则是使用过。
大多数时候我看到左括号和右括号警告:
PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket
PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket
存储库中的 WordPress 核心规则集说:
<rule ref="PEAR.Functions.FunctionCallSignature">
<properties>
<property name="requiredSpacesAfterOpen" value="1"/>
<property name="requiredSpacesBeforeClose" value="1"/>
</properties>
</rule>
这让我觉得警告是合法的(?)。如果是这样,为什么WP核心文件没有完全遵循WP自己的代码标准呢?
从历史上看,WordPress 避免清理核心代码样式,原因如下:
- 检查编码标准的工具不是特别可靠。近年来,随着 WordPress 编码标准 (WPCS) 项目的成熟,许多小的边缘案例在 PHPCS 中得到修复。
- 没有可靠的自动化工具,这将是一项手动工作,需要多次提交。这会导致不必要的代码改动,并使查看修订日志变得更加困难。
- 它只是没有被高度重视。 ~4% 的 WordPress PHP 违反了编码标准,所以大多数人不会遇到它。
随着工具的成熟,这一立场最近发生了变化,现在有一个 in-progress effort 可以让 PHPCS 和 WPCS 与 WordPress 核心一起工作。通过适当的自动化测试,WordPress 将在未来继续匹配其自己的编码标准。