A set of Magento rules for PHP_CodeSniffer tool.
To use within your Magento 2 project you can use:
composer require --dev magento/magento-coding-standardDue to security, when installed this way the Magento standard for phpcs cannot be added automatically.
You can achieve this by adding the following to your project's composer.json:
"scripts": {
"post-install-cmd": [
"([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/)"
],
"post-update-cmd": [
"([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/)"
]
}You can install Magento Coding Standard by cloning this GitHub repo:
git clone git@github.com:magento/magento-coding-standard.git
cd magento-coding-standard
composer installIt is possible also to install a standalone application via Composer
composer create-project magento/magento-coding-standard --stability=dev magento-coding-standardCommand should return the list of installed coding standards including Magento2.
vendor/bin/phpcs -iOnce installed, you can run phpcs from the command-line to analyze your code MyAwesomeExtension
vendor/bin/phpcs --standard=Magento2 app/code/MyAwesomeExtensionAlso, you can run phpcbf from the command-line to fix your code MyAwesomeExtension for warnings like "PHPCBF CAN FIX THE [0-9]+ MARKED SNIFF VIOLATIONS AUTOMATICALLY"
vendor/bin/phpcbf --standard=Magento2 app/code/MyAwesomeExtensionSee the community contribution model.
- Documentation of existing rules. See ExtDN PHP CodeSniffer rules for Magento 2 as a good example.
- Bug fixes and improvements of existing rules.
- Creation of new PHP CodeSniffer rules.
- Discussions on new rules (through periodic hangouts or discussions per GitHub issue).
- Start with looking into Community Dashboard. Any ticket in
Up for grabsis a good candidate to start. - Didn't satisfy your requirements? Create one of three types of issues:
- Bug report - Found a bug in the code? Let us know!
- Existing rule enhancement - Know how to improve existing rules? Open an issue describe how to enhance Magento Coding Standard.
- New rule proposal - Know how to improve Magento ecosystem code quality? Do not hesitate to open a proposal.
- The issue will appear in the
Backlogcolumn of the Community Dashboard. Once it will be discussed and getacceptedlabel the issue will appear in theUp for grabscolumn.
All rules should be covered by unit tests. Each Test.php class should be accompanied by a Test.inc file to allow for unit testing based upon the PHP_CodeSniffer parent class AbstractSniffUnitTest.
You can verify your code by running
vendor/bin/phpunitAlso, verify that the sniffer code itself is written according to the Magento Coding Standard:
vendor/bin/phpcs --standard=Magento2 Magento2/ --extensions=phpPrerequisites: Node.js (^12.22.0, ^14.17.0, or >=16.0.0).
You need to run the following command to install all the necessary packages described in the package.json file:
npm installYou can just execute ESLint as follows:
npm run eslint -- path/to/analyzeRun the following command to execute JSCS:
npm run jscs path/to/analyzeEach Magento source file included in this distribution is licensed under the OSL-3.0 license.
Please see LICENSE.txt for the full text of the Open Software License v. 3.0 (OSL-3.0).