Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 1.03 KB

README.md

File metadata and controls

49 lines (38 loc) · 1.03 KB
Raw

FIGLAB Coding Standard

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