Close search
Hoa

Hack book of Hoa\Devtools

Unfortunately, the documentation of this library has not been written yet. However, the README.md file may contain enough information to help you. This document is an extract of the README.md file.
Sorry for this inconvenience. Be ensured we are working hard to fix this.

Help on IRC Help on Gitter Documentation Board

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

Learn more.

Quick usage

We propose a quick overview of some commands.

cs

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

$ hoa devtools:cs --diff .

Requires PHP-CS-Fixer to be installed.

dependency

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 => …

diagnostic

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"

documentation

Generate the documentation of all libraries installed:

$ hoa devtools:documentation

expandflexentities

Expand entity names to ease auto-completion in IDE.

$ hoa devtools:expandflexentities

paste

Paste something somewhere (by default, on paste.hoa-project.net).

$ echo 'foobar' | hoa devtools:paste
http://paste.hoa-project.net:80/<id>

requiresnapshot

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 hoa devtools:snapshot.

state

Get the state of a library.

$ hoa devtools:state core
finalized

An error or a suggestion about the documentation? Contributions are welcome!

Comments

menu