osinet / qa
Drupal的质量保证工具
dev-8.x-1.x
2023-03-26 16:11 UTC
Requires
- php: >=7.3
- drupal/core: ^8 || ^9 || ^10
Requires (Dev)
- nikic/php-parser: ^4.8@dev
Suggests
- osinet/grafizzi: To plot dependencies
This package is auto-updated.
Last update: 2024-09-26 19:37:27 UTC
README
此模块需要在您的站点上安装,以便对Drupal生产数据库、配置存储(D9/D8)和文件布局的各个方面进行检查。
它还包含D7和D6的分支,每个分支都在相应的版本上运行。
买者注意 - 使用此模块并解释其结果需要深入了解核心操作:仅仅因为检查报告了可疑数据并不意味着实际上存在问题,而只是需要人工审查。这个工具主要是为了帮助专业审计人员审查网站;它并不适用于普通情况下的网站管理员。
内置检查
QA设计为可以通过实现控制插件的附加模块进行扩展。
- 计划:检查预计将开发,但尚未开始
- TBP:待移植 = 检查在早期版本中存在,但尚未移植到D9/D8。
- WIP:进行中。
QA还包括一些非检查命令。
图形
- 启用模块和主题的依赖关系图,可用于较小站点的Web UI或从drush获取较大图形。此功能将生成GraphViz
.dot
文件,通过Graphvizdot
命令转换,通常通过如下方式管道输出
$ drush qa-dependencies | dot -Tsvg > qa_dependencies.svg
- 在Drupal 8.3及更高版本中,给定工作流程中的转换图(对于核心工作流程,不是对于贡献工作流程模块)。此功能将生成GraphViz
.dot
文件,通过Graphvizdot
命令转换,通常通过如下方式管道输出
$ drush qa_workflow_graph | dot -Tsvg > qa_workflow.svg
- 工作流程图还有一个表格版本。
版权和许可
此模块版权所有 © 2005-2020 Frédéric G. MARAND,为 OSInet。
本程序是免费软件;您可以在自由软件基金会发布的GNU通用公共许可证的条款和条件下重新分发和/或修改它;许可证的第2版,或者(根据您的选择)任何后续版本。
本程序按照希望它是有用的,但没有任何保证;甚至没有关于适销性或适用于特定目的的暗示性保证。有关详细信息,请参阅GNU通用公共许可证。
您应该已经收到一份GNU通用公共许可证副本,与该程序一起;如果没有,请写信给自由软件基金会,Inc.,51 Franklin Street,第五层,波士顿,MA 02110-1301,USA。
贡献
开发附加自定义检查遵循此流程
- 创建自定义模块
- 创建一个
QaCheck
插件,它将实现QaCheckInterface
,并且可能基于QaCheckBase
进行简化。其属性包括id
:与任何Drupal插件一样。名称应类似于<package>.<check_name>
,其中<package>
将用于在UI中将相关包分组。插件预计位于Plugin\QaCheck\<Package>
目录中,而不是仅位于Plugin\QaCheck
目录中。label
:插件的简短描述,用于管理员列表。details
:可选。插件目的的较长描述,用于Web UI中的帮助。默认:空。usesBatch
:可选。启用使用批处理API进行长时间运行的检查(WIP)。默认:false
。steps
:可选。检查报告的不同步骤的数量。默认:1。
- 向
QaCommands
添加一个命令,调用QaCommands::runPlugin($name)
。
欢迎贡献:使用 Github 问题和拉取请求。