neuecommerce/coding-standards

Coding standards for Neue Commerce projects.

dev-main 2024-03-23 10:19 UTC

Requires

• php: ^8.3
• composer-plugin-api: ^2.1
• composer/composer: ^2.5
• nunomaduro/larastan: ^2.9
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-mockery: ^1.0
• phpstan/phpstan-strict-rules: ^1.5
• rector/rector: ^1.0
• symplify/easy-coding-standard: ^12.0

MIT

• Neue Commerce Team

• php
• coding-standards
• neuecommerce

README

This repository contains the coding standards followed by Neue Commerce projects.

It includes configuration for:

• Easy Coding Standard (ecs)
• PHPStan (phpstan)
• Rector (rector)

Setup

First install the dependency through Composer by running:

composer require neuecommerce/coding-standards --dev

Once the dependency is installed, run the following:

composer neuecommerce:setup-coding-standards

Next open your composer.json file and add the following section:

"scripts": {
    "ecs:fix": "./vendor/bin/ecs --fix",
    "ecs:check": "./vendor/bin/ecs",
    "phpstan": "./vendor/bin/phpstan analyse --ansi",
    "rector:fix": "./vendor/bin/rector process --ansi",
    "rector:check": "./vendor/bin/rector process --ansi --dry-run"
},

Note: If you already have a scripts section on your composer.json file, just merge the new scripts with the existing ones.

Usage

To use it, you can run one of the scripts added to your composer.json file:

composer ecs:fix
composer ecs:check
composer phpstan
composer rector:fix
composer rector:check

License

This package is open-sourced software licensed under the MIT license.