wpsh / wpcs-for-envato
WordPress coding standards for Envato plugins and themes
Installs: 40
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Type:phpcodesniffer-standard
Requires
- wp-coding-standards/wpcs: ^2.0
Requires (Dev)
- sclable/xml-lint: ^0.2.4
Suggests
- dealerdirect/phpcodesniffer-composer-installer: A Composer plugin for automatically configuring the coding standards.
This package is auto-updated.
Last update: 2024-10-25 20:38:44 UTC
README
Automatically check for Envato WordPress plugin and theme coding requirements. Based on the official WordPress coding standards but more relaxed.
Requirements
Setup
-
Add these coding standards as a Composer development dependency to your project:
composer require --dev wpsh/wpcs-for-envato
-
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 andcomposer 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.