跳转正文

yoyoboot repo map ​

需要了解仓库结构、package、规则范围、解决方案和进行中的规格任务时使用。结果每次从当前工作树读取,不维护第二份仓库地图。

基本用法 ​

text
yoyoboot repo map [--repo <path>] [--json]

在 YoyoBoot 源码仓库中运行 ​

查询当前仓库结构及正式来源。

text
pnpm --dir tools/yoyoboot-cli run cli -- repo map --json

参数 ​

参数必填说明
--json否以 JSON 输出完整结果信封,供机器读取。
--help否展示帮助;yoyoboot --help / yoyoboot <command> --help。
--repo <path>否显式指定仓库查找起点;缺省从当前工作目录向上查找。

示例 ​

固定示例仓库中的返回结果 ​

text
yoyoboot repo map --json

此命令针对固定示例仓库。下面只展示公开字段投影,不是当前 checkout 的完整输出。

json
{
  "command": "repo map",
  "status": "ok",
  "data": {
    "schemaVersion": "2.0.0",
    "packages": [
      {
        "directory": "packages/example",
        "name": "@example/package",
        "scripts": {
          "verify": "example-check"
        }
      }
    ],
    "activeChanges": [],
    "solutions": []
  }
}

返回结果 ​

仓库事实地图。

主要字段 ​

字段说明
command实际结果命令名;Admin 保留子命令名,入口捕获异常时为 cli。
statusok / warn / error;同时检查退出码及诊断码。warn 可以退出 0。
findings[]诊断项包含 code、status、message,可选 detail;机器使用 code 分支,不解析消息。
sourceJSON 顶层命令实现来源,包含 kind / path / owner。
data命令结果;入口捕获失败时可能缺省,部分诊断失败仍保留结果。
data.schemaVersion结果合同版本:2.0.0。
data.source工作树事实来源 { kind: runtime, path: git:working-tree, owner: git }。
data.capabilities[]每项包含 id / owner / source / entrypoints;package、主规格及正式工具入口来自现有事实源。
data.capabilities[].entrypoints[]已有入口 { command, args, cwd, source };列出入口不会执行它。
data.packages[]package 的 directory / name / scripts / source。
data.activeChanges[]正式 tasks 的 name / completedTasks / incompleteTasks / source;不推断业务验收状态。
data.rules[]全部规则来源 { kind, path, owner },不返回规则正文。
data.solutions[]解决方案文件来源 { kind: manifest, path, owner: dotnet }。

使用说明 ​

  • 仓库根使用 pnpm --dir tools/yoyoboot-cli run cli -- <命令参数>;已完成构建时也可使用 node tools/yoyoboot-cli/dist/bin.js <命令参数>。
  • JSON 示例来自固定示例仓库的公开投影,省略实现来源、规则文件位置及大段内容;<...> 是明确的环境占位符。完整字段见返回结果表,实际内容以当前工作树为准。
  • 全局参数严格解析:未知、重复、缺值参数返回退出码 2;--help 输出文本,即使同时指定 --json。
  • 只读;不接受位置参数或 --dry-run。地图中的全部入口仍需按具体改动选择。

退出码 ​

Exit code含义
0成功或仅有警告;警告仍需阅读。
2预期失败:参数、仓库或领域条件不满足,或严格检查未通过。
1未预期程序错误。

相关命令 ​

YoyoBoot · 从真实项目走向可复用能力