https://github.com/jobaria/quality-tools

Set of quality tools for your application.
https://github.com/jobaria/quality-tools

code-quality codesniffer composer-normalize grumphp php-cs-fixer phpmd phpstan psalm static-analysis

Last synced: 4 months ago
JSON representation

Set of quality tools for your application.

• Host: GitHub
• URL: https://github.com/jobaria/quality-tools
• Owner: jobaria
• License: mit
• Created: 2020-12-28T14:21:37.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2020-12-28T14:26:05.000Z (over 5 years ago)
• Last Synced: 2024-12-11T14:56:40.599Z (over 1 year ago)
• Topics: code-quality, codesniffer, composer-normalize, grumphp, php-cs-fixer, phpmd, phpstan, psalm, static-analysis
• Language: PHP
• Homepage:
• Size: 5.86 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# quality-tools

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

[![Packagist Version](https://img.shields.io/packagist/v/jobaria/quality-tools.svg?style=flat-square&include_prereleases)](https://packagist.org/packages/jobaria/quality-tools)

[![PHP Version](https://img.shields.io/badge/php-%5E8.0-8892BF.svg?style=flat-square)](http://www.php.net)

Set of quality tools for your application. Based on [GrumPHP](https://github.com/phpro/grumphp), including the following tools:

- [Composer Normalize](https://github.com/ergebnis/composer-normalize)

- [Codesniffer](https://github.com/squizlabs/PHP_CodeSniffer)

- [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)

- [PHPMD](https://github.com/phpmd/phpmd)

- [PHPStan](https://github.com/phpstan/phpstan)

- [Psalm](https://github.com/vimeo/psalm)

## Requirements

Required to install and run quality-tools:

- Composer (v2.0) (https://getcomposer.org)

- Phive (https://phar.io)

## Installation

Install via composer:

```

$ composer require --dev jobaria/quality-tools

```

When composer completes, run the following commands:

```shell script

# 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.