stellarwp / coding-standards
Code sniffing rules for StellarWP
Installs: 147 176
Dependents: 6
Suggesters: 0
Security: 0
Stars: 7
Watchers: 41
Forks: 1
Type:phpcodesniffer-standard
Requires
- php: >=7.4
- automattic/vipwpcs: ^3.0
- slevomat/coding-standard: ^8.14.0
- squizlabs/php_codesniffer: ^3.8.0
- wp-coding-standards/wpcs: ^3.0.0
Requires (Dev)
Suggests
- dealerdirect/phpcodesniffer-composer-installer: ^0.7 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically.
README
StellarWP coding standards uses a combination of:
- Generic (part of PHP_CodeSniffer)
- PEAR (part of PHP_CodeSniffer)
- PSR2 (part of PHP_CodeSniffer)
- Squiz (part of PHP_CodeSniffer)
- Zend (part of PHP_CodeSniffer)
- Custom sniffs (a few based on WordPress)
Important
Make sure that the command phpcs
is on version 3.4.2
+. In order to install it on that specifc version globally you can use:
composer global require "squizlabs/php_codesniffer=3.4.2"
Setup on PHPStorm
You can follow this guide the only step you can replace is the one on Installing via Composer by the one above to install the 3.4.2 version instead.
Example Usage via phpcs.xml
File
<?xml version="1.0"?> <ruleset name="StellarWP Coding Standards"> <rule ref="WordPress-VIP-Go"/> <rule ref="WordPress-Docs"> <exclude-pattern>*/tests/*</exclude-pattern> </rule> <rule ref="WordPress"> <exclude name="WordPress.Files.FileName"/> <exclude name="Generic.Arrays.DisallowShortArraySyntax"/> </rule> <rule ref="StellarWP"/> <!--exclude the rule for violation of direct DB calls as some have no alternative--> <rule ref="WordPress.DB.DirectDatabaseQuery"> <exclude-pattern>src/Test.php</exclude-pattern> </rule> <exclude-pattern>*/tests/_support/_generated/*</exclude-pattern> <exclude-pattern>*/vendor/*</exclude-pattern> </ruleset>