byteever/byteever-sniffs

ByteEver PHP 编码规范

安装: 895

依赖: 0

建议: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

v1.0.2 2024-06-28 06:59 UTC

This package is auto-updated.

Last update: 2024-09-28 07:39:23 UTC


README

ByteEver 的 PHP_CodeSniffer sniff 集合。

安装

composer require byteever/byteever-sniffs

用法

命令行

$ ./vendor/bin/phpcs .

如果依赖 Composer,编辑 composer.json 文件,添加以下内容:

	"scripts" : {
		"lint": [
			"phpcs ."
		],
	}

然后通过以下方式进行检查:

$ composer run lint

IDE 集成

一些 PHPCS 的 IDE 集成无法注册 ByteEver-Default 规则集。为了解决这个问题,在项目根目录放置 .phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="ByteEver Coding Standards">
	<description>My projects ruleset.</description>

	<!-- Configs -->
	<config name="minimum_supported_wp_version" value="4.7" />
	<config name="testVersion" value="7.2-" />

	<!-- Rules -->
	<rule ref="ByteEver-Defaults" />

	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array" value="new-text-domain" />
		</properties>
	</rule>

	<rule ref="PHPCompatibility">
		<exclude-pattern>tests/</exclude-pattern>
	</rule>
</ruleset>