The Hoa\Devtools library.
Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
This library contains several development tools. This is for developers or maintainers. Sometimes it can be useful to users also, but in particular cases.
$ composer require hoa/devtools '~1.0'
For more installation procedures, please read the Source page.
Before running the test suites, the development dependencies must be installed:
$ composer install
Then, to run all the test suites:
$ vendor/bin/hoa test:run
For more information, please read the contributor guide.
We propose a quick overview of some commands.
$ hoa devtools:cs --diff .
Requires PHP-CS-Fixer to be installed.
Check the dependencies of a specific library.
$ hoa devtools:dependency console Dependency for the library Console: • hoa/consistency => … • hoa/event => … • hoa/exception => … • hoa/file => … • hoa/stream => … • hoa/ustring => …
Help to write (and send) a diagnostic report. Very useful to help users.
$ hoa devtools:diagnostic --section bin [bin] self = "…/hoa" hoa = "/usr/local/lib/Hoa.central" php_dir = "…/bin" php = "…/bin/php"
Generate the documentation of all libraries installed:
$ hoa devtools:documentation
Expand entity names to ease auto-completion in IDE.
$ hoa devtools:expandflexentities
Check if a library requires a new snapshot or not.
$ hoa devtools:requiresnapshot console A snapshot is required, since … days (tag …, … commits to publish)!
If yes, you are probably likely to use
Get the state of a library.
$ hoa devtools:state core finalized
hack book of
contains detailed information about how to use this library and how it works.
To generate the documentation locally, execute the following commands:
$ composer require --dev hoa/devtools $ vendor/bin/hoa devtools:documentation --open
More documentation can be found on the project's website: hoa-project.net.
There are mainly two ways to get help:
Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE for details.