featherphp/quality-tools

Set of code quality tools

This package's canonical repository appears to be gone and the package has been frozen as a result.

0.6.0 2020-12-23 18:58 UTC

Requires

• php: ^7.4 || ^8.0
• composer-plugin-api: ^2.0
• composer/composer: ^2.0
• sensiolabs/security-checker: ^6.0

MIT

• Feather

• codesniffer
• static-analysis
• phpmd
• php-cs-fixer
• PHPStan
• code-quality
• psalm
• grumphp
• composer-normalize
• composer-require-checker
• sensiolabs-security-checker

README

Set of code quality tools, based on the GrumPHP ecosystem, including:

• Composer Normalize
• Composer Require Checker
• Codesniffer
• PHPCSFixer
• PHPMD
• PHPStan
• Psalm
• Sensiolabs Security Checker

Requirements

The following tools are required to install and run quality-tools:

• Composer (v2.0) (https://getcomposer.org)
• Phive (https://phar.io)

Installation

Install via composer:

$ composer require --dev featherphp/quality-tools

When composer completes, run the following commands:

# Install the necessary quality tools
$ phive install

# Enable GrumPHP and sniff your commits
$ tools/grumphp git:init

After install, edit configuration files (copied to your root folder) to your personal preferences.

Usage

All tools will be run automatically on git-commit via GrumPHP.