newsuk/nuk-wp-phpcs-config

WordPress VIP 插件和主题的 PHPCS 配置

维护者

详细信息

github.com/newsuk/nuk-wp-phpcs-config

来源

问题

安装次数: 12,391

依赖关系: 1

建议者: 0

安全: 0

星标: 3

关注者: 16

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

v0.4.1 2024-05-07 17:09 UTC

Requires

MIT 6377d346d15a4300a4b3ffa651a26cd8807545b2

  • Content Platforms <contentplatforms.woop@news.co.uk>

This package is auto-updated.

Last update: 2024-09-22 12:11:59 UTC

README

NUK WP PHPCS 配置

这个库包含 NewsUK 插件和主题的 WordPress VIP PHPCS 配置。

要求

  • PHP 8.2
  • WordPress 6.2

安装

Composer 安装

composer require --dev newsuk/nuk-wp-phpcs-config

使用规则集

在您的项目中创建一个 phpcs.xml.dist 文件，并添加以下内容以使用 NewsUK 规则集

<?xml version="1.0"?>
<ruleset name="NewsUK WP PHPCS Rules">
	<rule ref="NewsUK"/>
</ruleset>

💡 建议在不进行自定义或覆盖规则的情况下，直接使用 NewsUK 或 NewsPress 规则集。

覆盖或添加自定义规则

您还可以按以下方式覆盖或添加自定义规则到配置中。

<?xml version="1.0"?>
<ruleset name="NewsUK WP PHPCS Rules">
	<rule ref="NewsUK"/>
	<!-- Overriding the existing text_domain -->
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array">
				<element value="your_plugin_domain"/>
			</property>
		</properties>
	</rule>
</ruleset>

Composer 脚本

将以下内容添加到 composer.json 文件中的 scripts 部分，以运行 linting。

"lint": "phpcs .",
"lint:fix": "phpcbf .",