Magento Coding Standard

https://github.com/magento/magento-coding-standard
Admin
A set of PHP_CodeSniffer rules for enforcing Magento coding standards and best practices in Magento...
Tokens:4,361
Snippets:82
Trust Score:9.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Magento Coding Standard via Git Clone

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Install the Magento Coding Standard for development by cloning the GitHub repository and running Composer install.

```bash
git clone git@github.com:magento/magento-coding-standard.git
cd magento-coding-standard
composer install
```

--------------------------------

### Install ESLint Dependencies

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Install all necessary Node.js packages for ESLint as described in the package.json file.

```bash
npm install
```

--------------------------------

### Verify Magento Coding Standard Installation

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Verify that the Magento Coding Standard is installed and recognized by PHP_CodeSniffer.

```bash
vendor/bin/phpcs -i
```

--------------------------------

### Example: Run Rector PHP for Magento CMS Model

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

An example of running Rector PHP to process the Magento CMS Model directory, including the autoload file.

```bash
vendor/bin/rector process magento2ce/app/code/Magento/Cms/Model --dry-run --autoload-file magento2ce/vendor/autoload.php
```

--------------------------------

### Install Magento Coding Standard with Composer

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Install the Magento Coding Standard as a development dependency in your Magento 2 project using Composer.

```bash
composer require --dev magento/magento-coding-standard
```

--------------------------------

### Configure PHP_CodeSniffer for Magento Standard

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Add the Magento standard path to your project's composer.json to enable automatic configuration after installation or updates.

```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/)"
]
}
}
```

--------------------------------

### Run Unit Tests for Coding Standard Rules

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Execute unit tests to verify the correctness of the coding standard rules using PHPUnit.

```bash
vendor/bin/phpunit
```

--------------------------------

### Create Standalone Magento Coding Standard Project

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Create a standalone project for the Magento Coding Standard using Composer create-project.

```bash
composer create-project magento/magento-coding-standard --stability=dev magento-coding-standard
```

--------------------------------

### Execute ESLint for Code Analysis

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Run ESLint to analyze JavaScript code in a specified path.

```bash
npm run eslint -- path/to/analyze
```

--------------------------------

### Run Rector PHP for Specific Magento Project Path

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Process a specific Magento project path with Rector PHP, providing the project's autoload file.

```bash
vendor/bin/rector process MAGENTO_PATH --dry-run --autoload-file MAGENTO_AUTOLOAD_FILE
```

--------------------------------

### Analyze Code with Magento2 Standard

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Run PHP_CodeSniffer to analyze your Magento 2 extension code using the Magento2 standard.

```bash
vendor/bin/phpcs --standard=Magento2 app/code/MyAwesomeExtension
```

--------------------------------

### Verify Sniffer Code with Magento Standard

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Check if the sniffer code itself adheres to the Magento Coding Standard.

```bash
vendor/bin/phpcs --standard=Magento2 Magento2/ --extensions=php
```

--------------------------------

### Set Magento Coding Standard Dependency

Source: https://github.com/magento/magento-coding-standard/wiki/Magento-Coding-Standard-Versioning

To ensure users always follow the latest version of the Coding Standard, set the dependency to "*". This applies to core developers, community contributors, system integrators, and extension developers.

```json
    "require-dev": {
        ...
        "magento/magento-coding-standard": "*",
        ...
    }
```

--------------------------------

### Use ViewModels Instead of Helpers in Magento Templates

Source: https://github.com/magento/magento-coding-standard/blob/develop/Magento2/Sniffs/Templates/ThisInTemplateSniff.md

Refactor helper calls in PHTML templates to use ViewModels. This promotes better separation of concerns and maintainability.

```php
<?php $viewModel = $block->getViewModel(); ?>
```

```php
<?php $viewModel = $block->getData('viewModel'); ?>
```

--------------------------------

### Optimized Array Merging After Loop

Source: https://github.com/magento/magento-coding-standard/blob/develop/Magento2/Sniffs/Performance/ForeachArrayMergeSniff.md

To improve performance, collect all arrays within the loop and then merge them once after the loop completes. This approach significantly reduces the overhead associated with repeated merging.

```php
$options = [];
foreach ($configurationSources as $source) {
    // code here
    $options[] = $source->getOptions();
}

$options = array_merge([], ...$options);
```

--------------------------------

### Dry Run Rector PHP for Magento Coding Standard

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Execute Rector PHP with the Magento Coding Standard rules in dry-run mode to see potential changes without applying them.

```bash
vendor/bin/rector process Magento2 Magento2Framework PHP_CodeSniffer --dry-run --autoload-file vendor/squizlabs/php_codesniffer/autoload.php
```

--------------------------------

### Fix Code Issues Automatically with phpcbf

Source: https://github.com/magento/magento-coding-standard/blob/develop/README.md

Use the phpcbf tool to automatically fix code style violations identified by the Magento2 standard.

```bash
vendor/bin/phpcbf --standard=Magento2 app/code/MyAwesomeExtension
```

--------------------------------

### Inefficient Array Merging in Loop

Source: https://github.com/magento/magento-coding-standard/blob/develop/Magento2/Sniffs/Performance/ForeachArrayMergeSniff.md

Avoid using `array_merge` inside a loop as it is a resource-intensive operation that can slow down execution and increase CPU usage. This pattern is common but should be refactored for better performance.

```php
$options = [];
foreach ($configurationSources as $source) {
    // code here
    $options = array_merge($options, $source->getOptions());
}
```

--------------------------------

### Update composer.json for Magento Coding Standard

Source: https://github.com/magento/magento-coding-standard/wiki/Release

Modify the composer.json file to include the Magento Coding Standard as a development dependency. This is typically done when testing local changes or preparing for a release.

```json
{
    ...
    "require-dev": {
        ...
        "magento/magento-coding-standard": "dev-[branch]"
        ...
    }
    ...
    "minimum-stability": "dev",
    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/[fork]/magento-coding-standard"
        }

    ]

}
```

--------------------------------

### Avoid $this in Magento Templates

Source: https://github.com/magento/magento-coding-standard/blob/develop/Magento2/Sniffs/Templates/ThisInTemplateSniff.md

In PHTML templates, use `$block` instead of `$this` to access the current block. This is a deprecated practice that may be removed in future versions.

```php
<?php $_incl = $this->helper(<helper_class>)->...; ?>
```
Tokens:
Raw