youwe / coding-standard-magento2
Youwe PHP Coding Standard for Magento2
Installs: 92 490
Dependents: 17
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 6
Open Issues: 0
Type:phpcodesniffer-standard
Requires
- dealerdirect/phpcodesniffer-composer-installer: ^0.7.2 || ^1.0
- magento/magento-coding-standard: >= 9
- youwe/coding-standard: ^3.5.0
README
This is the Youwe coding standard for Magento 2 projects. It is based on the default Magento2 coding standard but some tests have been removed to create a workable and fast standard.
Installation
Use composer to require the standard in a project.
composer require --dev youwe/coding-standard-magento2 -W
To let PHPCS know that this standard should be used add a phpcs.xml file in the root of the project.
<?xml version="1.0"?> <ruleset> <rule ref="YouweMagento2"/> </ruleset>
Integration with PHPStorm and automatic testing
The recommended way to enable the coding standard in PHPStorm and automatic testing is by requiring the Youwe testing suite in a project.
composer require --dev youwe/testing-suite
For more information go to Youwe Testing Suite.
Contribution guidelines
Contributions are welcome. Please create pull requests which add or remove tests.