macfja/phpqa-extensions

More tools for PHPQA

PHPQA Extensions

Add more tools to PHPQA

List of tools

• PHP Magic Number Detector: PHP Magic Number Detector.
• PhpAssumptions: Tool to detect assumptions.
• PhpCodeAnalyzer: PhpCodeAnalyzer finds usage of non-built-in extensions in your php code.

Usage

Get the list of available tools

$ php vendor/bin/phpqa-extensions.php --tools

List of available tools
=======================

 --------------------------- -------- ----------------------------- ----------- 
  Name                        CLI      Composer                      Installed  
 --------------------------- -------- ----------------------------- ----------- 
  PhpAssumptions              phpa     rskuipers/php-assumptions     No        
  PhpCodeAnalyzer             phpca    wapmorgan/php-code-analyzer   No        
  PHP Magic Number Detector   phpmnd   povils/phpmnd                 No        
 --------------------------- -------- ----------------------------- ----------- 

Install a tool on a project

$ php vendor/bin/phpqa-extensions.php --add phpmnd

or

$ php vendor/bin/phpqa-extensions.php --add "PHP Magic Number Detector"

or

$ php vendor/bin/phpqa-extensions.php --add povils/phpmnd

Several tools can be add in one times:

$ php vendor/bin/phpqa-extensions.php --add phpmnd --add phpa

Enable an external tool

$ php vendor/bin/phpqa-extensions.php --enable phpmnd:\MacFJA\PHPQAExtensions\Tools\Analyzer\PhpMagicNumber:app/report/phpmagicnumber.xsl

The syntax of the parameter --enabled is: $CLI_NAME$:$WRAPPER_CLASS$ or $CLI_NAME$:$WRAPPER_CLASS$:$REPORT_PATH$. With:

• $CLI_NAME$: The name of the CLI command
• $WRAPPER_CLASS$: The class that will be used by PHPQA to call the tool
• $REPORT_PATH$: The relative path of the XLST file to do the HTML transformation (optional)

Options

Option name	Default	Tool	Description
phpmnd.ignore-numbers	null	PHP Magic Number Detector	List (comma separate) of number to ignore (typically 0,1,2)
phpmnd.ignore-funcs	null	PHP Magic Number Detector	List (comma separate) of function to ignore
phpmnd.ignore-strings	null	PHP Magic Number Detector	List (comma separate) of strings value to ignore
phpmnd.strings	false	PHP Magic Number Detector	Activate the strings literal analysis
phpca.since	null	PhpCodeAnalyzer	Only include extensions not included since version
phpca.extension	null	PhpCodeAnalyzer	Look for usage of a specific extension

How to contribute

If you found a nice tool that you want to added, open a issue on GitHub.

You can also create Pull Request of a new tool.

phpqa-extensions's Issues

New tool: PHP DocBlock Checker

Data type	Value
Tool name	PHP DocBlock Checker
Composer	block8/php-docblock-checker
Repository	https://github.com/Block8/php-docblock-checker
Website	https://github.com/Block8/php-docblock-checker
Xml Output	No
Cli return code	Yes
Cli Output	Yes

The tool provide an JSON output

Issue with dependency YAML

The version constraint of symfony/yaml is too restrictive.

New tool: PHP_Testability

Data type	Value
Tool name	PHP_Testability
Composer	edsonmedina/php_testability
Repository	https://github.com/edsonmedina/php_testability
Xml Output	No
Cli return code	No
Cli Output	Yes

The CLI output just indicate that a file have been analysed and time performance.

The tool provide a HTML report and a CSV report

New tool: PhpCodeFixer

Data type	Value
Tool name	PhpCodeFixer
Composer	wapmorgan/php-code-fixer
Repository	https://github.com/wapmorgan/PhpCodeFixer
Website	http://wapmorgan.github.io/PhpCodeFixer/
Xml Output	No
Cli return code	Yes
Cli Output	Yes

The tool return 1 if an error exist

Add documentation on contributing

Add more documentation on how to contribute to the project.

• Code of conduct
• Type of contribution
• Step by step tutorial on how to create a new tool extension
• The expected code quality/code style
• Issue template for new tool

New Tool: Phan

Data type	Value
Tool name	Phan
Composer	phan/phan
Repository	https://github.com/phan/phan
Website	https://github.com/phan/phan/wiki/Getting-Started
Xml Output	Yes
Cli return code	Yes
Cli Output	Yes

New tool: PhpCodeAnalyzer

Data type	Value
Tool name	PhpCodeAnalyzer
Composer	wapmorgan/php-code-analyzer
Repository	https://github.com/wapmorgan/PhpCodeAnalyzer
Xml Output	No
Cli return code	No
Cli Output	Yes

Add the support of the tool wapmorgan/PhpCodeAnalyzer: PhpCodeAnalyzer finds usage of non-built-in extensions in your php code.

The tool don't have XML output. (And adding it look pretty difficult)

New Tool: PHP Extensions Finder for Composer

Data type	Value
Tool name	PHP Extensions Finder for Composer
Composer	dg/php-extensions-finder
Repository	https://github.com/dg/php-extensions-finder
Xml Output	NO
Cli return code	NO
Cli Output	YES

New tool: composer unused

Would be awesome to support composer unused

• https://packagist.org/packages/icanhazstring/composer-unused

It detects non used packages and creates a report of that knowledge

Data type	Value
Tool name	composer-unused
Composer	icanhazstring/composer-unused
Repository	https://github.com/composer-unused/composer-unused
Xml Output	NO
Cli return code	YES
Cli Output	YES

Allow the cli command to just enable a tool

In the current version (0.1.0), the cli command can only update the .phpqa.yml (<=> enable a tool) after installing a Composer package.

The issue is: if the tools can not be installed by Composer, then it's impossible to use phpqa-extensions to enable it

But the code already have everything to only update the file .phpqa.yml (see MacFJA\PHPQAExtensions\ToolInstaller\updatePhpQaConfig)

New Tool: solidifier

Data type	Value
Tool name	solidifier
Composer	andreybolonin/solidifier
Repository	https://github.com/andreybolonin/solidifier
Xml Output	No
Cli return code	No
Cli Output	Yes

The tool generate a HTML report