ionbytes/coding-standard

IonBytes Coding Standard

Maintainers

Details

github.com/ionbytes/coding-standard

Source

Issues

Installs: 130

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:phpcodesniffer-standard

1.0.0 2024-04-04 04:07 UTC

Requires

Requires (Dev)

MIT b6bffda3bf1898f88cd129eb97fadd29d5d5c1bd

static analysisstandardsphpcs

This package is not auto-updated.

Last update: 2024-12-14 21:41:26 UTC

README

Installation

  1. Install via composer by running: 
    composer require --dev ionbytes/coding-standard
  2. Create the phpcs.xml.dist file in root path of you repository: 
    <?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
    
    <arg name="basepath" value="."/>
    <arg name="cache" value=".phpcs-cache"/>
    <arg name="colors"/>
    <arg name="extensions" value="php"/>
    <arg name="parallel" value="80"/>
    
    <!-- Show progress -->
    <arg value="sp"/>
    
    <!-- Paths to check -->
    <file>src</file>
    <file>tests</file>
    
    <!-- Include all rules from the IonBytes Coding Standard -->
    <rule ref="IonBytes"/>
</ruleset>
  3. Add composer scripts into your composer.json: 
    {
  "scripts": {
    "cs-check": "phpcs",
    "cs-fix": "phpcbf -vpw"
  }
}

Usage

  • To run checks only:

    composer run cs

  • To automatically fix violations coding standards:

    composer run cs-fix

License

The MIT License (MIT). Please see License for more information