Download the PHP package inpsyde/php-coding-standards without Composer
On this page you can find all versions of the php package inpsyde/php-coding-standards. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download inpsyde/php-coding-standards
More information about inpsyde/php-coding-standards
Files in inpsyde/php-coding-standards
Package php-coding-standards
Short Description PHP 7.4+ coding standards for Syde WordPress projects.
License MIT
Informations about the package php-coding-standards
Syde PHP Coding Standards
PHP 7.4+ coding standards for Syde WordPress projects.
Usage
When the package is installed via Composer, and dependencies are updated, everything is ready and the coding standards can be checked via:
Here, <path>
is at least one file or directory to check, for example:
There are many options that can be used to customise the behavior of the command, to get documentation use:
Configuration File
A phpcs.xml.dist
file can be used to avoid passing many arguments via the command line.
For example:
Such a configuration allows to run the code style check like so:
Moreover, thanks to the text_domain
setting, PHP_CodeSniffer will also check that all WordPress
internationalization functions are called with the proper text domain.
Included rules
For the detailed lists of included rules, refer to ruleset.xml
.
PSR-1, PSR-2, PSR-12
For more information about included rules from PHP Standards Recommendations (PSR), refer to the official documentation:
WordPress Coding Standards
To ensure code quality, and compatibility with WordPress VIP, some rules have been included from:
Slevomat
A few rules have been included from the Slevomat Coding Standard.
PHPCompatibility
For PHP cross-version compatibility checks, the full PHP Compatibility Coding Standard for PHP CodeSniffer standard has been included.
The target PHP version (range) can be changed via a custom phpcs.xml
file.
Generic Rules
Some rules are also included from PHP_CodeSniffer itself, as well as PHPCSExtra.
Custom Rules
The following custom rules are in use:
Sniff Name | Description | Has Config | Auto-Fixable |
---|---|---|---|
ArgumentTypeDeclaration |
Enforce argument type declaration. | ||
DisableCallUserFunc |
Disable usage of call_user_func . |
||
DisableMagicSerialize |
Disable usage of __sleep , __wakeup . |
||
DisableSerializeInterface |
Disable usage of Serializable interface. |
||
DisallowShortOpenTag |
Disallow short open PHP tag (short echo tag allowed). | ||
ElementNameMinimalLength |
Use minimum 3 chars for names (with a few exclusions) | ✓ | |
EncodingComment |
Detect usage of opening -*- coding: utf-8 -*- |
✓ | ✓ |
ForbiddenPublicProperty |
No public class properties | ||
FunctionBodyStart |
Handle blank line at start of function body. | ✓ | |
FunctionLength |
Max 50 lines per function/method, excluding blank lines and comments-only lines. | ✓ | |
HookClosureReturn |
Ensure that actions callbacks do not return anything, while filter callbacks return something. | ||
HookPriority |
Report usage of PHP_INT_MAX and PHP_INT_MIN as hook priority. |
||
LineLength |
Max 100 chars per line | ✓ | |
NestingLevel |
Max indent level of 3 inside functions | ✓ | |
NoAccessors |
Discourage usage of getters and setters. | ||
NoElse |
Discourage usage of else . |
||
NoRootNamespaceFunctions |
Report usage of global functions in the root namespace. | ||
NoTopLevelDefine |
Discourage usage of define where const is preferable. |
||
PropertyPerClassLimit |
Discourage usage of more than 10 properties per class. | ✓ | |
Psr4 |
Check PSR-4 compliance | ✓ | |
ReturnTypeDeclaration |
Enforce return type declaration | ||
StaticClosure |
Points closures that can be static . |
✓ | |
VariablesName |
Check variable (and properties) names | ✓ |
For notes and configuration, refer to the inpsyde-custom-sniffs.md
file in this repository.
Template Rules
The InpsydeTemplates
ruleset extends the standard Inpsyde
ruleset with some template-specific
sniffs.
The recommended way to use the InpsydeTemplates
ruleset is as follows:
The following template-specific rules are available:
Sniff Name | Description | Has Config | Auto-Fixable |
---|---|---|---|
AlternativeControlStructure |
Encourage usage of alternative syntax with inline HTML. | ||
ShortEchoTag |
Replace echo with short echo tag in single-line statements. | ✓ | |
TrailingSemicolon |
Remove trailing semicolon before closing PHP tag. | ✓ |
Removing or Disabling Rules
Rules Tree
Sometimes it is necessary not to follow some rules. To avoid error reporting, it is possible to:
- remove rules for an entire project via configuration;
- disable rules from code, only is specific places.
In both cases, it is possible to remove or disable:
- a complete standard;
- a standard subset;
- a single sniff;
- a single rule.
These things are in a hierarchical relationship: standards are made of one or more subsets, which contain one or more sniffs, which in turn contain one or more rules.
Removing Rules via Configuration File
Rules can be removed for the entire project by using a custom phpcs.xml
file, like this:
In the example above, the PSR1.Classes.ClassDeclaration
sniff (and all the rules it contains)
has been removed.
By using PSR1
instead of PSR1.Classes.ClassDeclaration
, one would remove the entire PSR1
standard, whereas using PSR1.Classes.ClassDeclaration.MultipleClasses
would remove this one rule
only, but no other rules in the PSR1.Classes.ClassDeclaration
sniff.
Removing Rules via Code Comments
Removing a rule/sniff/subset/standard only for a specific file or a part of it can be done by using
special phpcs
annotations/comments, for example, // phpcs:disable
followed by an optional name
of a standard/subset/sniff/rule. Like so:
For more information about ignoring files, please refer to the official PHP_CodeSniffer Wiki.
IDE Integration
PhpStorm
After installing the package as explained above, open PhpStorm settings, and navigate to
Language & Frameworks
-> PHP
-> Quality Tools
-> PHP_CodeSniffer
Choose "Local" in the "Configuration" dropdown.
Click the "..." button next to the dropdown. It will show a dialog where you need to specify the path for the PHP_CodeSniffer executable.
Open the file selection dialog, navigate to vendor/bin/
in your project, and select phpcs
.
On Windows, choose phpcs.bat
.
Click the "Validate" button next to the path input field. If everything is working fine, a success message will be shown at the bottom of the window.
Still in the PhpStorm settings, navigate to:
Editor
-> Inspections
Type codesniffer
in the search field before the list of inspections, then select:
PHP
-> Quality Tools
-> PHP_CodeSniffer validation
Enable it using the checkbox in the list, press "Apply".
Select _"PHPCodeSniffer validation", click the refresh icon next to the "Coding standard"
dropdown on the right, and choose Inpsyde
.
If you don't see Inpsyde
here, you may need to specify the phpcs.xml
file by selecting
"Custom" as standard and then use the "..." button next to the dropdown.
Once the PhpStorm integration is complete, warnings and errors in your code will automatically be shown in your IDE editor.
Installation
Via Composer, require as development dependency:
All versions of php-coding-standards with dependencies
automattic/vipwpcs Version ^3.0.0
dealerdirect/phpcodesniffer-composer-installer Version ~1.0.0
phpcompatibility/php-compatibility Version ^9.3.5 || ^10
phpcsstandards/phpcsextra Version ^1.1
phpcsstandards/phpcsutils Version ^1.0
slevomat/coding-standard Version ^8.13