opencode-business-flow-reviewer

English · 中文

一个 OpenCode 插件，从产品经理视角检查业务流程的完整性与可闭环性 （而非代码质量）。输出一组结构化发现（严重等级、维度、规则、位置、修复建议） 以及覆盖率评分。

无构建步骤。OpenCode 内置的 Bun 运行时直接 import 原始的 src/index.ts， 因此本包发布的是 TypeScript 源码，并要求 Bun（见 engines.bun）。

安装

本包包含两部分：工具（由插件注册）和技能（从文件系统发现）。npm 的 plugin 引用只会安装工具，技能需要复制到你的 OpenCode 配置目录。

1. 在 opencode.json 中引用插件：

   { "plugin": ["opencode-business-flow-reviewer"] }

2. 安装技能（让 business-flow-review 可以自动触发）：

   # 全局（~/.config/opencode）；传入项目根目录则装到 <root>/.opencode
   node_modules/opencode-business-flow-reviewer/scripts/install.sh
   node_modules/opencode-business-flow-reviewer/scripts/install.sh doctor   # 校验

   或者不装技能，直接调用 business_flow_review 工具。

business_flow_review 工具

| 参数 | 类型 | 默认 | 说明 | | --- | --- | --- | --- | | input | string | — | 原始流程文本，或包含流程的文件路径。 | | mode | auto | prd | journey | code | auto | 审查模式。auto 根据内容自动判断。 | | directory | string | 会话目录 | 项目目录（用于解析文件路径）。 | | maxFindings | number | 50 | 最多展示的发现数（不影响评分）。 |

模式

• prd — 需求文档 / 用户故事：角色、目标、场景、触发条件、分支、异常、成功标准。
• journey — 用户 / 交互流程：端到端步骤、状态迁移、决策点、退出 / 回退路径。
• code — TS/JS 实现：未覆盖分支、缺失补偿 / 幂等 / 超时、危险的状态写入顺序。
• auto — 按扩展名和内容选择模式；空 / 无法识别的输入会返回"无可分析内容"的终态（不会编造发现）。

覆盖率评分基于全量发现（在 maxFindings 截断之前）相对于该模式实际评估的维度计算， 因此不会因为 maxFindings 调小而虚高。

开发

bun install            # 在仓库根目录执行（依赖会被提升）
bun run typecheck      # tsc --noEmit
bun test               # 单元 + 工具 + index 测试
bun run test:e2e       # 冒烟测试（加载真实插件）

许可证

MIT © 2026 lijiamin (李家民)。