ionbytes / coding-standard
IonBytes Coding Standard
Installs: 130
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:phpcodesniffer-standard
Requires
- php: >=8.1
- dealerdirect/phpcodesniffer-composer-installer: dev-master
- squizlabs/php_codesniffer: ^4.0.x-dev
Requires (Dev)
- roave/security-advisories: dev-master
This package is not auto-updated.
Last update: 2024-10-19 20:49:45 UTC
README
Installation
- Install via composer by running:
composer require --dev ionbytes/coding-standard
- 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>
- 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