qubus / qubus-coding-standard
Qubus Coding Standard
Installs: 65
Dependents: 22
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Type:phpcodesniffer-standard
Requires
- php: >=8.1
- dealerdirect/phpcodesniffer-composer-installer: ^0.7.2
- slevomat/coding-standard: ^8.5
- squizlabs/php_codesniffer: ^3.7
- webimpress/coding-standard: ^1.2
This package is auto-updated.
Last update: 2024-10-29 19:18:30 UTC
README
Coding standard rulesets for QubusPHP.
QubusPHP coding standards loosely follows the Laminas Coding Style Guide with a few exceptions:
- Abstract classes MUST NOT be prefixed/suffixed with
Abstract. - Traits MUST NOT be prefixed/suffixed with
Trait. - Interfaces MUST NOT be prefixed/suffixed with
InterfaceorContract. - Exceptions MUST be suffixed with
Exception. - File name of classes must be in PascalCase.
- File names of functions must be in lowercase and can be delimited with
_. - Custom functions must be namespaced and imported when used.
- Classes must be coded to interfaces and follow SOLID.
Installation
- Install the coding standard as a dependency of your project:
$ composer require --dev qubus/qubus-coding-standard
- Add coding standard to the PHP_CodeSniffer install path:
vendor/bin/phpcs --config-set installed_paths vendor/qubus/qubus-coding-standard
- Run the standards:
vendor/bin/phpcs /path/to/code