easy-coding-standard - Implement PHP Code Standards with Easy Parallel Processing

Introduction to Easy Coding Standard (ECS)

Easy Coding Standard (ECS) is a dynamic tool aimed at maintaining consistent code quality for PHP developers. It’s designed to seamlessly integrate with any PHP project ranging from version 7.2 to 8.3, regardless of the existing dependencies.

Killer Features

ECS stands out with several impressive features that make it a preferred choice for developers:

Wide Compatibility: ECS can be installed on any PHP project from version 7.2 to 8.3, ensuring broad applicability.
High Speed: It operates at remarkable speeds, leveraging parallel processes to enhance efficiency.
Versatility: ECS combines the functionality of both PHP_CodeSniffer and PHP-CS-Fixer, giving developers the flexibility to use either of these according to their preference.
Prepared Sets: Users can take advantage of pre-configured sets and PHP CS Fixer sets, significantly reducing setup time and effort.

Installation

To integrate ECS into your PHP project, a simple Composer command does the trick:

composer require symplify/easy-coding-standard --dev

Usage

Running ECS is straightforward. The initial command creates a configuration file, ecs.php, with a basic setup:

vendor/bin/ecs

Subsequent runs will highlight suggested code changes. To implement these changes, users can add the --fix option:

vendor/bin/ecs --fix

Configuration

The default configuration suits most needs, but users can customize ECS by specifying paths, checkers, and pre-configured rule sets:

use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withConfiguredRule(
        ArraySyntaxFixer::class,
        ['syntax' => 'long']
    );

ECS also allows users to include rule sets from PHP CS Fixer or skip specific rules or files, providing a flexible approach to code standardization.

Advanced Options

For more specialized needs, ECS offers additional options:

File Extensions: Specify which file types to scan.
Cache Configuration: Optimize cache settings for environments like GitLab CI.
Parallel Processing: Adjust settings for parallel execution to better manage resource use.

Automation with Composer Scripts

To standardize ECS operations across different projects, developers can automate the process using Composer scripts:

vendor/bin/ecs scripts

This setup includes handy commands such as composer check-cs for code checks and composer fix-cs for applying fixes.

Output Formats

ECS supports various output formats for reports, including:

Console: For human-readable output.
JSON: For integration with tools that require JSON formatted data.
JUnit: Suitable for CI tools.
Checkstyle: Useful for GitHub Actions.
GitLab: For GitLab CI pipelines or Code Climate tools.

Frequently Asked Questions

Clearing Cache: To clear ECS cache, execute:
```
vendor/bin/ecs --clear-cache
```
Listing Rules: To view all active rules, use:
```
vendor/bin/ecs list-checkers
```

For a JSON formatted list, append the --output-format json option.

Migration from Other Tools

Migrating to ECS from other tools like PHP_CodeSniffer or PHP CS Fixer is a streamlined process, ensuring a smooth transition to this comprehensive coding standard solution.

ECS empowers PHP developers by simplifying code standardization, offering speed, versatility, and ease of use within any PHP environment.