diablomedia/arcanist-extensions

Arcanist 和 Phabricator/Phorge 用于代码审查/测试的扩展集合

1.1.0 2024-09-04 16:23 UTC

README

Arcanist(也应适用于 Arcanist 的任何分支,如捆绑在 Phorge 中的)提供的扩展

安装

推荐使用 composer 安装这些扩展。依赖项很少(只有一个,用于 php-cs-fixer linter),因此不应该存在许多依赖冲突。

composer require diablomedia/arcanist-extensions --dev

如果无法使用 composer 安装,您可以将此仓库克隆到系统中的某个位置,并将您的 .arcconfig 指向安装路径。您也可以将其安装在与您的 arcanistlibphutil 目录相同的位置,arcanist 应该会在那里找到扩展。

配置

要启用此仓库中的所有扩展,只需将一行添加到您的 .arcconfig 文件的 "load" 部分即可

{
  "load": ["vendor/diablomedia/arcanist-extensions/extensions/"]
}

如果您不想在配置中启用所有扩展(技术上它们直到在您的 .arclint(用于 linters)或 .arcconfig(用于单元测试引擎)中配置后才使用),您可以单独加载每个扩展,例如

{
  "load": [
    "vendor/diablomedia/arcanist-extensions/extensions/composer_validate_linter",
    "vendor/diablomedia/arcanist-extensions/extensions/phpstan_linter"
  ]
}

要配置扩展以在您的 arcanist 项目中运行,请参考以下每个扩展的 README 文件。

包含的扩展

  • 审查器
  • 单元测试引擎
    • Jest - 运行 Jest(用于 JavaScript 测试)并处理覆盖率报告
    • Vitest - 运行 Vitest(用于 JavaScript 测试)并处理覆盖率报告
    • Multi Test Engine - 允许配置多个单元测试引擎(对于包含不同语言测试的存储库很有用,例如 PHP 和 JS 用于包含服务器端(PHP)和客户端(JavaScript)测试的存储库)

致谢

其中一些审查器来自 GitHub 上其他审查器的分支,这些审查器通常不再维护(或我们因某些功能差异而进行了分支,这些差异对我们来说效果更好)。请参阅每个审查器的 README 文件,该文件将链接回原始项目。