@agentworkforce/review-kit

中文文档
4.2.1发布于 2026/10/05TypeScriptES Module构建来源已验证近 30 天下载 1.3万

Strongly typed factories for charter-driven GitHub pull-request reviewers. The kit owns event parsing, repo/draft/label gates, evidence collection, read-only checkout configuration, comment delivery, and retry idempotency; a reviewer supplies its lens, ch

原始使用文档

@agentworkforce/review-kit

Strongly typed factories for charter-driven GitHub pull-request reviewers. The kit owns event parsing, repo/draft/label gates, evidence collection, read-only checkout configuration, comment delivery, and retry idempotency; a reviewer supplies its lens, charter, and evidence.

// agent.ts
import {
  defineReviewAgent,
  gitHistory,
  prDiff
} from '@agentworkforce/review-kit';

export default defineReviewAgent({
  repo: 'AgentWorkforce/workforce',
  charter: '.agentworkforce/workforce/personas/maintainability.md',
  lens: 'maintainability',
  evidence: [prDiff(), gitHistory()]
});
// persona.ts
import { defineReviewPersona } from '@agentworkforce/review-kit';

export default defineReviewPersona({
  repo: 'AgentWorkforce/workforce',
  lens: 'maintainability',
  systemPrompt: 'Review maintainability against the checked-in charter.',
  fetchDepth: 'full'
});

Custom evidence providers implement ReviewEvidenceProvider, or use defineReviewEvidence() to preserve a literal provider name.

Encoded failure boundaries

The factory deliberately encodes the seven silent failures from workforce issue #281:

  1. It accepts flattened, raw nested, and normalized Relayfile PR payloads.
  2. Trigger paths are concrete strings in the extracted agent spec.
  3. Every trigger mounts both pulls/** and issues/**, because PR comments use GitHub's issue-comment path.
  4. GitHub triggers never declare where; the handler retains a repo guard.
  5. The persona enables PR checkout but keeps branch writeback off. This relies on the clone-only credential contract fixed in AgentWorkforce/cloud#2664.
  6. Comment writes are fire-and-forget. A missing receipt is logged as unconfirmed and is never turned into a delivery retry. The kit requires a real Relayfile mount because durable dedupe must read canonical comments; it never mixes filesystem reads with HTTP writes or writes a stray cwd draft.
  7. The comment command path and hidden audit marker are keyed by lens + head SHA. A retry sees the existing command and skips before running the harness.

The factory also logs its package version on each handler invocation, making the bundled review-kit version visible in deployed logs.

版本与发布记录

@agentworkforce/review-kit 共发布 34 个版本,首次发布于 2026/07/17;过去 12 个月发布了 34 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.2.1latest2026/10/051 个月前
4.2.02026/10/021 个月前
4.1.612026/09/301 个月前
4.1.602026/09/301 个月前
4.1.592026/09/181 个月前
4.1.582026/09/151 个月前

关于 @agentworkforce/review-kit 的常见问题

@agentworkforce/review-kit 是什么?

Strongly typed factories for charter-driven GitHub pull-request reviewers. The kit owns event parsing, repo/draft/label gates, evidence collection, read-only checkout configuration, comment delivery, and retry idempotency; a reviewer supplies its lens, ch

如何安装 @agentworkforce/review-kit?

在项目目录运行 npm install @agentworkforce/review-kit,或使用 pnpm add / yarn add / bun add。

@agentworkforce/review-kit 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@agentworkforce/review-kit 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@agentworkforce/review-kit 可以商用吗?

@agentworkforce/review-kit 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@agentworkforce/review-kit 的下载量有多少?

根据 npm 官方下载统计,@agentworkforce/review-kit 在 2026/10/05 – 2026/11/03 这 30 天内被下载 13,211 次,日均约 440 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@agentworkforce/review-kit 还在维护吗?

最新版本 4.2.1 发布于 2026/10/05(1 个月前);至今共发布 34 个版本,其中过去 12 个月发布了 34 个;首次发布于 2026/07/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。