jmolivas/phpqa

PHP QA Analyzer

PHPQA

PHPQA Analyzer CLI tool, _(*1)

, _(*2)

• Overview
• Available Analyzers
• Install
• Usage
• Override configuration
• Nice to have features

Overview

This project aims to serve as a CLI tool to make easy the use of different PHP tools related to Quality Assurance and code analysis in PHP., _(*3)

Every analyzer tool handles arguments and options using different formats, the goal of this project is to provide a single way to interact with those projects, you can also set options and arguments using a default configuration file when the project supports it., _(*4)

This project was originally developed as part of Drupal Console and based on the blog post Write your git hooks in PHP and keep them under git control., _(*5)

Available Analyzers

• PHP Parallel Lint, _(*6)

  This tool check syntax of PHP files faster then serial check with fancier output., _(*7)

  , _(*8)

• PHP Coding Standards Fixer, _(*9)

  The PHP Coding Standards Fixer tool fixes most issues in your code when you want to follow the PHP coding standards as defined in the PSR-1 and PSR-2 documents., _(*10)

  , _(*11)

• PHP_CodeSniffer, _(*12)

  PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations., _(*13)

  , _(*14)

  , _(*15)

• PHPMD - PHP Mess Detector, _(*16)

  It is a spin-off project of PHP Depend and aims to be a PHP equivalent of the well known Java tool PMD. PHPMD can be seen as an user friendly and easy to configure frontend for the raw metrics measured by PHP Depend., _(*17)

  , _(*18)

• PHPLOC, _(*19)

  phploc is a tool for quickly measuring the size and analyzing the structure of a PHP project., _(*20)

  , _(*21)

• PHPDCD - PHP Dead Code Detector, _(*22)

  phpdcd is a Dead Code Detector (DCD) for PHP code. It scans a PHP project for all declared functions and methods and reports those as being "dead code" that are not called at least once., _(*23)

  , _(*24)

• PHPCPD - PHP Copy/Paste Detector, _(*25)

  phpcpd is a Copy/Paste Detector (CPD) for PHP code., _(*26)

  , _(*27)

• PHPUnit, _(*28)

  PHPUnit is a programmer-oriented testing framework for PHP. It is an instance of the xUnit architecture for unit testing frameworks., _(*29)

  , _(*30)

Install

Cloning the project

$ git clone git@github.com:jmolivas/phpqa.git
$ cd phpqa
# download dependencies
$ composer install
# make phpqa globally accessible creating a symlink
$ ln -s /path/to/phpqa/bin/phpqa /usr/local/bin/phpqa

Usage

Copy configuration file(s)

$ cd to/project/path
$ phpqa init --project=PROJECT --override
$ phpqa init --global --override

NOTES: - Option global does not accept a value must be set as --global. - Option override does not accept a value must be set as --override. - Options project and global can not used in combination., _(*31)

Analyze a project

$ cd to/project/path
$ phpqa analyze --project=PROJECT --files=FILES
$ phpqa analyze --project=PROJECT --git

NOTES: - Option git does not accept a value must be set as --git. - Option project could be omitted if a phpqa.yml or phpqa.yml.dist file is available at current working directory. - Options files and git can not used in combination., _(*32)

Override configuration

This project was built to be fully customizable, you can enable/disable analyzers and modify arguments/options passed to analyzers by updating the phpqa.yml or phpqa.yml.dist file on your project root copied when running init command, or the files ~/.phpqa/php/config.yml, ~/.phpqa/symfony/config.yml or ~/.phpqa/drupal/config.yml copied when running init command using --global option., _(*33)

Nice to have features

• Add command to create new project.
• Add more analyzers:
  • https://github.com/pdepend/pdepend
  • https://github.com/sensiolabs/security-checker
  • https://github.com/sensiolabs/insight
  • https://github.com/Halleck45/PhpMetrics
• Add analyzer via config and not as composer dependency.
• Detect if analyzer is already loaded on the local machine and use that instead of download.
• Add custom analyzers.
• Add SaaS analyzers via API.

This project is a work-in-progress and needs some love related to code clean up, test coverage and documentation., _(*34)