bitban/php-code-quality-tools

PHP Code Quality Tools used in Bitban projects.

Tuesday, December 19, 2017
by bitban
Repository
4 Watchers
2 Stars
4,875 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
4 Open issues
18 Versions
13 % Grown

The README.md

PHP Code Quality Tools

, _(*1)

These tools may be used to detect and fix some common errors before committing them to the code repository., _(*2)

Check command reference section for more detailed information., _(*3)

Installation

If you have not done this yet, add bin directory to composer.json:, _(*4)

composer config bin-dir bin/, _(*5)

It will add something like this to your composer.json file:, _(*6)

"config": {
    "bin-dir": "bin/"
}

For a better experience, we also suggest to configure post-install and post-update script:, _(*7)

"scripts": {
    "post-install-cmd": [
        "Bitban\\PhpCodeQualityTools\\Composer\\ScriptHandler::checkHooks"
    ],
    "post-update-cmd": [
        "Bitban\\PhpCodeQualityTools\\Composer\\ScriptHandler::checkHooks"
    ]
}

Then, require new dev dependency:, _(*8)

composer require --dev "bitban/php-code-quality-tools:dev-master", _(*9)

After that, a new command is available from project's root path:, _(*10)

bin/php-cqtools, _(*11)

Command reference

Check Git Hooks

Checks if Git hooks are installed for current project. If not, it gives a hint to install them, but does not take any action automatically., _(*12)

bin/php-cqtools hooks:check, _(*13)

Install Git Hooks

Installs Git hooks into .git/hooks/. If destination files already exist, the are backed up., _(*14)

bin/php-cqtools hooks:install, _(*15)

Git hooks managed are:, _(*16)

pre-commit
post-checkout
post-merge

pre-commit hook

It calls code:validate command., _(*17)

bin/php-cqtools code:validate --only-commited-files, _(*18)

post-checkout hook

It checks whether composer.lock has changed or not. If so, launches composer install command., _(*19)

bin/php-cqtools hooks:post-checkout <prevCommit> <postCommit> [<projectPath>], _(*20)

projectPath argument sets path to be processed. Default value is current project base path., _(*21)

post-merge hook

It has the same behaviour than post-checkout hook., _(*22)

bin/php-cqtools hooks:post-merge [<projectPath>], _(*23)

Uninstall Git Hooks

Removes Git hooks from destination path. If backup files exist, they are restored., _(*24)

bin/php-cqtools hooks:uninstall, _(*25)

Fix Code Style

Fixes code style of files according to defined code style., _(*26)

It may fix all project files or only files to be commited. This second option is very convinient to fix errors detected in pre-commit hook., _(*27)

bin/php-cqtools code:fix-codestyle [--dry-run] [--excluded-paths=EXCLUDED_PATHS] [--only-commited-files] [--custom-ruleset=CUSTOM_RULESET] [<projectPath>], _(*28)

projectPath argument sets path to be processed. Default value is current project base path., _(*29)

--dry-run option shows diffs without applying any changes to files. --excluded-paths option sets some paths not to be processed. --only-commited-files option processes only files scheduled to be commited. --custom-ruleset option sets phpcs custom ruleset to be used instead of default one, _(*30)

Validate Code

It performs several tasks:, _(*31)

PHP files:
- Check for syntax errors
- Check that forbidden functions (i.e., var_dump(), empty()) are not commited
- Check whether multibyte string functions are being used
- Check that code complies defined code style recommendations (errors cannot be commited, warnings may be)
- Check that variable usage is right (i.e., use undefined variables, parameters not used, etc.)
JSON files:
- Check for syntax errors
Composer related files:
- Check that composer.json is not commited without composer.lock (checked only with --only-commited-files modifier)

bin/php-cqtools code:validate [--excluded-paths=EXCLUDED_PATHS] [--only-commited-files] [--custom-ruleset=CUSTOM_RULESET] [<projectPath>], _(*32)

projectPath argument sets path to be processed. Default value is current project base path., _(*33)

--excluded-paths option sets some paths not to be processed. --only-commited-files option processes only files scheduled to be commited. --custom-ruleset option sets phpcs custom ruleset to be used instead of default one, _(*34)

Show debug information

Shows debug information about:, _(*35)

Validation/fix tools installed, such as phpcs, jsonlint, phpcbf
Project basepath
Git hooks path
Git hooks source path
Commited files
Excluded paths
Project files

bin/php-cqtools debug:show [--show-full-paths] [<projectPath], _(*36)

projectPath argument sets path to be processed. Default value is current project base path., _(*37)

--show-full-paths option enables full path file listing instead of relative path, _(*38)

This command, may be unavailable in any future versions of these tools, as it has been added for debug purposes., _(*39)

Run Bitban Lightweight tests

Runs Bitban's framework lightweight tests. It assumes that Bitban's Development VM is up and running, and it has test launcher script run_light_tests.sh installed., _(*40)

bin/php-cqtools test:run --vmHost[=VMHOST] [<projectPath], _(*41)

projectPath argument sets path to be processed. Default value is current project base path., _(*42)

--vmHost=VMHOST option sets Development VM hostname, _(*43)

This command has no use for projects not integrating Bitban's framework., _(*44)

References

Here are several interesting links with information (and inspiration) about this subject., _(*45)

https://carlosbuenosvinos.com/write-your-git-hooks-in-php-and-keep-them-under-git-control/
https://www.sitepoint.com/writing-php-git-hooks-with-static-review/
https://github.com/sdieunidou/php-git-hooks
http://tech.zumba.com/2014/04/14/control-code-quality/
https://www.sitepoint.com/8-must-have-php-quality-assurance-tools/
http://phpqatools.org/
https://github.com/illusori/PHP_Codesniffer-VariableAnalysis/

The Versions

19/12 2017

dev-master

9999999-dev

PHP Code Quality Tools used in Bitban projects.

library php-code-quality-tools