Download the PHP package drupol/php-conventions without Composer
On this page you can find all versions of the php package drupol/php-conventions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download drupol/php-conventions
More information about drupol/php-conventions
Files in drupol/php-conventions
Package php-conventions
Short Description PHP conventions based on GrumPHP.
License MIT
Informations about the package php-conventions
![Latest Stable Version][latest stable version] ![GitHub stars][github stars] ![Total Downloads][total downloads] ![License][license]
PHP conventions
Description
A developer tool which provides a pre-defined GrumPHP configuration tailored specifically for PHP development.
Features
The default GrumPHP configuration ships with the following checks:
- License file creation,
- Composer Require Checker,
composer.json
validation,- composer.json normalization,
- YAML Lint,
- JSON Lint,
- PHP Lint,
- Twig CS,
- PHP CS Fixer checks (Based on PSR12),
- PHP CS,
- PHPStan.
- PSalm,
It provides a default configuration for each task, and they are customizable at will through a simple YAML configuration file.
Tasks can be also added or skipped according to your need.
Installation
If you're not using GrumPHP
Manually add to your composer.json
file
Replace the string php73
with the minimal version of PHP you want to support.
Current choices are:
psr12
If you're using GrumPHP already
Edit the file grumphp.yml.dist
or grumphp.yml
and add on the top it:
To add an extra GrumPHP task:
In conjunction with extra_tasks
, use skip_tasks
to skip tasks if needed.
Usage
Basic usage
This will run all the pre-configured tasks.
Advanced usage
If you're willing to specify a group of tasks only, you can use the pre-defined test suites.
Available test-suites are:
cs
- license
- composer_require_checker
- composer
- composer_normalize
- yamllint
- jsonlint
- phplint
- twigcs
- phpcsfixer
static-analysis
- phpstan
- psalm
To run a particular test-suite:
To run particular tasks:
Contributing
Report bug on the issue tracker.
See the file [CONTRIBUTING.md][18] but feel free to contribute to this library by sending Github pull requests.
Changelog
See CHANGELOG.md for a changelog based on git commits.
For more detailed changelogs, please check the release changelogs.
To generate the changelog, use the following command:
[latest stable version]: https://img.shields.io/packagist/v/drupol/php-conventions.svg?style=flat-square [github stars]: https://img.shields.io/github/stars/drupol/php-conventions.svg?style=flat-square [total downloads]: https://img.shields.io/packagist/dt/drupol/php-conventions.svg?style=flat-square [license]: https://img.shields.io/packagist/l/drupol/php-conventions.svg?style=flat-square
[18]: https://github.com/drupol/php-conventions/blob/master/.github/CONTRIBUTING.md
All versions of php-conventions with dependencies
drupol/phpcsfixer-configs-php Version ^2
ergebnis/composer-normalize Version ^2
friendsoftwig/twigcs Version ^5 || ^6
loophp/grumphp-license-task Version ^1
maglnet/composer-require-checker Version ^3 || ^4
php-parallel-lint/php-parallel-lint Version ^1
phpro/grumphp Version ^1 || ^2
phpstan/extension-installer Version ^1.0
phpstan/phpstan Version ^1
phpstan/phpstan-deprecation-rules Version ^1.0
symfony/yaml Version ^6.4 || ^7
vimeo/psalm Version ^5