eve/coding-standard

eve's coding standard, built on top of slevomat/coding-standard

Maintainers

Details

github.com/Eveio/coding-standard

Source

Installs: 8 633

Dependents: 3

Suggesters: 0

Security: 0

Stars: 7

Watchers: 4

Forks: 0

v1.1.0 2021-04-12 11:46 UTC

Requires

MIT e58f93a1b8e4e5ad317f659ee72ecc2e1f78d91e

This package is auto-updated.

Last update: 2024-04-12 20:19:27 UTC

README

eve's coding standard for PHP CodeSniffer, built on top of slevomat/coding-standard. Intended to be used for Laravel-based projects.

Installation

Require the package with Composer:

composer require --dev eve/coding-standard

Usage

  1. In your ruleset.xml, add a rule referencing the package's included rule set:

    <?xml version="1.0"?>
<ruleset name="My Awesome Standards">
    <rule ref="./vendor/eve/coding-standard/ruleset.xml"/>

    <!-- add extra configurations if necessary -->
    <file>./app</file>
    <file>./bootstrap</file>
    <file>./config</file>
    <file>./database</file>
    <file>./routes</file>
    <file>./tests</file>
</ruleset>

  2. Use it!

    # check for violations
composer phpcs --standard=ruleset.xml

# fix the violations if applicable
composer phpcbf --standard=ruleset.xml

License

MIT of course.