tarosky/coding-standards

WordPress 项目的 Tarosky 编码规范，使用 PHP_CodeSniffer 规则集。

维护者

详细信息

github.com/tarosky/coding-standards

主页

源代码

问题

安装: 959

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 4

分支: 0

开放问题: 3

类型:phpcodesniffer-standard

0.1.0 2024-01-19 00:38 UTC

Requires

GPL-2.0-or-later 17fead74243305a6f86f8851241c44d663e99750

This package is auto-updated.

Last update: 2024-09-19 17:08:29 UTC

README

Tarosky 编码规范

安装

使用 Composer 进行安装。

composer require --dev tarosky/coding-standards

如果在最后出现以下确认信息，请输入 y。

dealerdirect/phpcodesniffer-composer-installer 包含一个目前不在您允许的插件配置中的 Composer 插件。请参阅 https://getcomposer.org/allow-plugins 您信任 "dealerdirect/phpcodesniffer-composer-installer" 执行代码并希望现在启用它吗？(将 "allow-plugins" 添加到 composer.json) [y,n,d,?]

安装完成后，composer.json 应该如下所示。

{
	"require-dev": {
		// ... 他のパッケージ
		"tarosky/coding-standards": "^1.0"
	},
	"config": {
		"allow-plugins": {
			"dealerdirect/phpcodesniffer-composer-installer": true
		}
	}
}

用法

通过命令执行时，可以这样做。

./vendor/bin/phpcs --standard=Tarosky .

通过在 composer.json 中设置脚本，可以使用更简单的命令来执行。以下示例中，使用 composer lint 可以执行 phpcs 代码检查，使用 composer fix 可以执行 phpcbf 自动修正。

"scripts": {
	"lint": "phpcs --standard=Tarosky .",
	"fix": "phpcbf --standard=Tarosky ."
},

此外，composer lint 可以与 GitHub Actions 等CI工具结合使用，确保在提交或拉取请求时始终执行，从而防止开发团队中的代码检查遗漏。