hoa/devtools

The Hoa\Devtools library.

, _(*1)

, _(*2)

Hoa is a modular, extensible and structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds. , _(*3)

Hoa\Devtools

, _(*4)

This library contains several development tools. This is for developers or maintainers. Sometimes it can be useful to users also, but in particular cases., _(*5)

Learn more., _(*6)

Installation

With Composer, to include this library into your dependencies, you need to require hoa/devtools:, _(*7)

$ composer require hoa/devtools '~1.0'

For more installation procedures, please read the Source page., _(*8)

Testing

Before running the test suites, the development dependencies must be installed:, _(*9)

$ composer install

Then, to run all the test suites:, _(*10)

$ vendor/bin/hoa test:run

For more information, please read the contributor guide., _(*11)

Quick usage

We propose a quick overview of some commands., _(*12)

cs

Fix coding style of Hoa. It embraces PSR-1 and PSR-2, in addition to some extra fixers., _(*13)

$ hoa devtools:cs --diff .

Requires PHP-CS-Fixer to be installed., _(*14)

dependency

Check the dependencies of a specific library., _(*15)

$ hoa devtools:dependency console
Dependency for the library Console:
    • hoa/consistency => …
    • hoa/event => …
    • hoa/exception => …
    • hoa/file => …
    • hoa/stream => …
    • hoa/ustring => …

diagnostic

Help to write (and send) a diagnostic report. Very useful to help users., _(*16)

$ hoa devtools:diagnostic --section bin
[bin]
self = "…/hoa"
hoa = "/usr/local/lib/Hoa.central"
php_dir = "…/bin"
php = "…/bin/php"

documentation

Generate the documentation of all libraries installed:, _(*17)

$ hoa devtools:documentation

expandflexentities

Expand entity names to ease auto-completion in IDE., _(*18)

$ hoa devtools:expandflexentities

requiresnapshot

Check if a library requires a new snapshot or not., _(*19)

$ hoa devtools:requiresnapshot console
A snapshot is required, since … days (tag …, … commits to publish)!

If yes, you are probably likely to use hoa devtools:snapshot., _(*20)

state

Get the state of a library., _(*21)

$ hoa devtools:state core
finalized

Documentation

The hack book of Hoa\Devtools contains detailed information about how to use this library and how it works., _(*22)

To generate the documentation locally, execute the following commands:, _(*23)

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

More documentation can be found on the project's website: hoa-project.net., _(*24)

Getting help

There are mainly two ways to get help:, _(*25)

• On the #hoaproject IRC channel,
• On the forum at users.hoa-project.net.

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know., _(*26)

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details., _(*27)