chrometoaster/backend-coding-standards

Back-end coding standards configuration used at Chrometoaster.

Maintainers

Details

github.com/chrometoasters/backend-coding-standards

Source

Issues

Installs: 1 699

Dependents: 2

Suggesters: 0

Security: 0

Stars: 1

Watchers: 5

Forks: 0

Open Issues: 1

1.4.0 2022-09-14 23:21 UTC

Requires

BSD-3-Clause e45915994e79d933b591252b3816083f72ceb444

This package is auto-updated.

Last update: 2024-12-15 04:13:16 UTC

README

Back-end coding standards used at Chrometoaster are based on PSR-2.

This project bundles tools along with predefined rulesets for automated checks. Provided tools:

Installation & usage

  1. Install this package:

    $ composer require --dev chrometoaster/backend-coding-standards:~1.0

  2. Include a configuration file in your easy-coding-standard.yml:

    imports:
    - { resource: '%vendor_dir%/chrometoaster/backend-coding-standards/config/chrometoaster.yml' }

  3. Check your files

    $ vendor/bin/parallel-lint /path/to/source/code
$ vendor/bin/ecs check path/to/source/code

  4. Auto-fix non-compliant files where possible

    $ vendor/bin/ecs check path/to/source/code --fix

See the official documentation of the tools used for further information, e.g. how to provide a custom config.

Licence

BSD-3-Clause