PHPQA
PHPQA Analyzer CLI tool
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.
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.
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.
Available Analyzers
-
This tool check syntax of PHP files faster then serial check with fancier output.
-
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.
-
PHP_CodeSniffer is a set of two PHP scripts; the main
phpcsscript that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a secondphpcbfscript to automatically correct coding standard violations. -
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.
-
phplocis a tool for quickly measuring the size and analyzing the structure of a PHP project. -
PHPDCD - PHP Dead Code Detector
phpdcdis 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. -
PHPCPD - PHP Copy/Paste Detector
phpcpdis a Copy/Paste Detector (CPD) for PHP code. -
PHPUnit is a programmer-oriented testing framework for PHP. It is an instance of the xUnit architecture for unit testing frameworks.
Install
Cloning the project
$ git clone [email protected]: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
| Option | Description |
|---|---|
| project | Available values php, symfony and drupal. |
| global | Copy configuration files to user home directory, instead of current working directory. |
| override | If this option is set, files are copied using override flag. |
NOTES:
- Option
globaldoes not accept a value must be set as--global. - Option
overridedoes not accept a value must be set as--override. - Options
projectandglobalcan not used in combination.
Analyze a project
$ cd to/project/path
$ phpqa analyze --project=PROJECT --files=FILES
$ phpqa analyze --project=PROJECT --git
| Option | Description |
|---|---|
| project | Available values php, symfony and drupal |
| files | Files or directories to analyze. |
| git | If this option is set, all files added to git index will be scanned. This is useful when setting executing this tool on a pre-commit git-hook. |
NOTES:
- Option
gitdoes not accept a value must be set as--git. - Option
projectcould be omitted if aphpqa.ymlorphpqa.yml.distfile is available at current working directory. - Options
filesandgitcan not used in combination.
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.
Nice to have features
- Add command to create new project.
- Add more analyzers:
- 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.
5 Jun 1, 2023
312 Dec 26, 2022
454 Dec 27, 2022
35 Dec 29, 2022
3 Jul 29, 2022
12 Oct 10, 2022
13 Dec 19, 2022
5k Dec 22, 2022
758 Dec 28, 2022
837 Dec 14, 2022
139 Jan 6, 2023
9 Oct 7, 2022
23 Dec 20, 2022
135 Dec 9, 2022
314 Dec 2, 2022
29 Aug 24, 2022
20 Aug 4, 2022