wpsh/wpcs-for-envato

WordPress coding standards for Envato plugins and themes

Maintainers

Details

github.com/wpsh/wpcs-for-envato

Source

Issues

Installs: 50

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 0

Open Issues: 0

Type:phpcodesniffer-standard

0.3.0 2019-02-15 17:27 UTC

Requires

Requires (Dev)

Suggests

MIT e0ec50d888964e2ebc09582e92de38aa9a20df06

  • Kaspars Dambis <hi.woop@kaspars.net>

This package is auto-updated.

Last update: 2024-10-25 20:38:44 UTC

README

Build Status

Automatically check for Envato WordPress plugin and theme coding requirements. Based on the official WordPress coding standards but more relaxed.

Requirements

Setup

  1. Add these coding standards as a Composer development dependency to your project:

    composer require --dev wpsh/wpcs-for-envato

  2. Define a script in composer.json to run the checks:

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

    Use composer phpcs to run the coding standard checks and composer phpcs-fix to automatically fix some of the coding standard violations.

Configuration

Add phpcs.xml.dist to your project root that provides additional configuration options:

<?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>

Credits

Created by Kaspars Dambis.