Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magento/marketplace-eqp
Magento 1.x Coding Standard
https://github.com/magento/marketplace-eqp
Last synced: 5 days ago
JSON representation
Magento 1.x Coding Standard
- Host: GitHub
- URL: https://github.com/magento/marketplace-eqp
- Owner: magento
- License: mit
- Created: 2016-05-04T19:52:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-27T16:34:58.000Z (over 5 years ago)
- Last Synced: 2024-11-02T01:32:52.183Z (11 days ago)
- Language: PHP
- Homepage: http://docs.magento.com/marketplace/user_guide/Resources/pdf/Extension_Quality_Program_Overview.pdf
- Size: 195 KB
- Stars: 224
- Watchers: 38
- Forks: 68
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magento Extension Quality Program Coding Standard
### :warning: Versions 3.0.0 and above of the MEQP Coding Standard are for Magento 1.x code only.
To check Magento 2.x code use [Consolidated Magento Coding Standard](https://github.com/magento/magento-coding-standard).
[](https://travis-ci.org/magento/marketplace-eqp)
Magento EQP Coding Standard is a set of rules and sniffs for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) tool.
It allows automatically check your code against some of the common Magento and PHP coding issues, like:
- raw SQL queries;
- SQL queries inside a loop;
- direct class instantiation;
- unnecessary collection loading;
- excessive code complexity;
- use of dangerous functions;
- use of PHP superglobals;
- code style issues and many others.
**Magento Extension Quality Program Coding Standard** consists of one ruleset - MEQP1 for Magento 1.x.
## Installation
Install all dependencies via [Composer](https://getcomposer.org):
```sh
$ composer create-project --repository=https://repo.magento.com magento/marketplace-eqp magento-coding-standard
```
You’re required to authenticate; see [Get your authentication keys](http://devdocs.magento.com/guides/v2.0/install-gde/prereq/connect-auth.html) for details.
## Usage
```sh
$ cd magento-coding-standard
```
Select the standard to run with PHP_CodeSniffer. To check Magento extension run:
```sh
$ vendor/bin/phpcs /path/to/your/extension --standard=MEQP1
```
By default, PHP_CodeSniffer will check any file it finds with a `.inc`, .`php`, `.js` or `.css` extension. To check design templates you can specify `--extensions=php,phtml` option.
To check syntax with specific PHP version set paths to php binary dir:
```sh
$ vendor/bin/phpcs --config-set php7.0_path /path/to/your/php7
$ vendor/bin/phpcs --config-set php5.4_path /path/to/your/php5.4
```
## Fixing Errors Automatically
PHP_CodeSniffer offers the PHP Code Beautifier and Fixer (`phpcbf`) tool. It can be used in place of `phpcs` to automatically generate and fix all fixable issues. We highly recommend run following command to fix as many sniff violations as possible:
```sh
$ vendor/bin/phpcbf /path/to/your/extension --standard=MEQP1
```
## Marketplace Technical Review
To make sure your extension will pass CodeSniffer checks of Magento Marketplace Technical Review, you could run `phpcs` command with `--severity=10` option.
```sh
$ vendor/bin/phpcs /path/to/your/extension --standard=MEQP1 --severity=10 --extensions=php,phtml
```
**All severity 10 errors must be fixed in order to successfully pass Level 1 CodeSniffer checks.**
## Requirements
* PHP >=5.5.0
* [Composer](https://getcomposer.org)
* [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) 3.*
> Notice: PHP and Composer should be accessible globally.
## Contribution
Please feel free to contribute new sniffs or any fixes or improvements for the existing ones.