README

Hoa 是一套 模块化、可扩展 和 结构化 的 PHP 库。
此外，Hoa 致力于成为工业界和研究界的桥梁。

Hoa\Devtools

此库包含多个开发工具。这是为开发人员或维护人员准备的。有时它对用户也有用，但仅在特定情况下。

了解更多.

安装

使用 Composer，要将此库包含到您的依赖项中，您需要要求 hoa/devtools

$ composer require hoa/devtools '~1.0'

有关更多安装程序，请阅读源码页面。

测试

在运行测试套件之前，必须安装开发依赖项

$ composer install

然后，要运行所有测试套件

$ vendor/bin/hoa test:run

有关更多信息，请阅读贡献者指南。

快速使用

我们提供了一些命令的快速概述。

cs

修复 Hoa 的编码风格。它包含 PSR-1 和 PSR-2，以及一些额外的修复器。

$ hoa devtools:cs --diff .

需要安装 PHP-CS-Fixer。

dependency

检查特定库的依赖项。

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

diagnostic

帮助编写（并发送）诊断报告。对帮助用户非常有用。

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

documentation

生成已安装所有库的文档

$ hoa devtools:documentation

expandflexentities

将实体名称扩展到易于在 IDE 中自动完成。

$ hoa devtools:expandflexentities

requiresnapshot

检查库是否需要新快照。

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

如果是这样，您很可能需要使用 hoa devtools:snapshot。

state

获取库的状态。

$ hoa devtools:state core
finalized

文档

Hoa\Devtools 的黑客手册包含有关如何使用此库以及它是如何工作的详细说明。

要本地生成文档，请执行以下命令

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

更多文档可以在项目的网站上找到： hoa-project.net。

获取帮助

主要有两种方式获取帮助

• 在 #hoaproject IRC频道上，
• 在 users.hoa-project.net 的论坛上。

贡献

您想贡献吗？谢谢！一个详细的贡献指南解释了您需要知道的一切。

许可

Hoa遵循新的BSD许可协议（BSD-3-Clause）。请参阅LICENSE以获取详细信息。