wpsh/wpcs-for-envato

Envato 插件和主题的 WordPress 编码规范

安装次数: 40

依赖项: 0

建议者: 0

安全性: 0

星标: 4

关注者: 2

分支: 0

开放性问题: 0

类型:phpcodesniffer-standard

0.3.0 2019-02-15 17:27 UTC

This package is auto-updated.

Last update: 2024-08-25 20:09:09 UTC


README

Build Status

自动检查 Envato WordPress 插件主题编码要求。基于官方的 WordPress 编码规范,但更加宽松。

要求

设置

  1. 将这些编码规范添加为您的项目中的 Composer 开发依赖

    composer require --dev wpsh/wpcs-for-envato
  2. composer.json 中定义一个脚本来运行检查

    {
    	"scripts": {
    		"phpcs": "./vendor/bin/phpcs --standard=WPCSForEnvato --extensions=php",
    		"phpcs-fix": "./vendor/bin/phpcbf --standard=WPCSForEnvato --extensions=php"
    	}
    }

    使用 composer phpcs 运行编码规范检查,并使用 composer phpcs-fix 自动修复一些编码规范违规。

配置

phpcs.xml.dist 添加到您的项目根目录,以提供额外的配置选项

<?xml version="1.0"?>
<ruleset name="WordPress coding standards for Envato">
	<rule ref="WPCSForEnvato"/>

	<!-- Specify a prefix that should be used for all global functions and variables. -->
	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
		<properties>
			<property name="prefixes" type="array">
				<element value="our_custom_prefix"/>
				<element value="tgmpa"/>
			</property>
		</properties>
	</rule>
</ruleset>

致谢

Kaspars Dambis 创建。