portavice / laravel-pint-config
Laravel Pint configuration used at portavice
Installs: 18 158
Dependents: 9
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/portavice/laravel-pint-config
Requires
- laravel/pint: ^1.25
README
This project contains the default configuration for Laravel Pint used at portavice GmbH.
The ruleset is based on PSR12 with additional rules for
- ordered class elements, imports, used interfaces and traits, parameter types, attributes,
- short syntax, proper indentation, trailing commas, square index braces for arrays,
- consistent imports, braces, operators, spacing, blank lines, formatting of PHPDoc and other comments,
- preferring single quotes,
- combining consecutive
issets orunsets, - enforcing PSR autoloading and global imports,
- enforcing PHPUnit standards (camel case for methods, data providers after the test using it, use attributes/code instead of PHPDoc when possible),
- and avoiding useless code (
else,return,sprintf, empty statements).
Contents
Installation
First, install the package via Composer:
composer require portavice/laravel-pint-config --dev
Note that this automatically installs Laravel Pint as well.
Usage
To simplify usage, you may configure the following scripts in your composer.json:
{
"scripts": {
"csPHP": "pint --config vendor/portavice/laravel-pint-config/pint.json --test",
"csfixPHP": "pint --config vendor/portavice/laravel-pint-config/pint.json"
}
}
Just run composer csPHP to check and composer csfixPHP to fix the PHP files in your Laravel project.
Otherwise, you will have to call the pint command with the --config option.
To use and adjust the set of rules defined by this package,
you can also copy the pint.json from this repository into your project.