figlab/coding-standard

PHPCS coding-standard for Laravel applications.

1.0.4 2024-08-06 01:40 UTC

Requires

• php: ^8.2
• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• interaction-design-foundation/coding-standard: ^0.3
• slevomat/coding-standard: ^8.14
• squizlabs/php_codesniffer: ^3.9

MIT

README

PHPCS coding-standard for Laravel applications and packages. Based on the awesome IxDF Coding Standard.

Installation

1. Install the package via composer by running:

composer require --dev figlab/coding-standard

1. Add composer scripts into your composer.json:

"scripts": {
  "cs:check": "phpcs -p -s --colors --report-full --report-summary",
  "cs:fix": "phpcbf -p --colors"
}

1. Create file phpcs.xml on base path of your repository with content

<?xml version="1.0"?>
<ruleset name="My Coding Standard">
    <!-- Include all rules from the IxDF Coding Standard -->
    <rule ref="FigLabCodingStandard"/>

    <!-- Paths to check -->
    <file>app</file>
    <file>config</file>
    <file>database</file>
    <file>lang</file>
    <file>routes</file>
    <file>tests</file>
</ruleset>

Usage

• To run checks only:

composer cs:check

• To automatically fix CS issues:

composer cs:fix