@cnbcool/cnb-api-generate 2.20.1 → 2.21.0

package/client/lib/register-modules.ts

@@ -32,15 +32,17 @@ const AUTO_INJECTED_DISPLAY_KEYS = new Set(['repo', 'number', 'review-id']);
 
 /**
  * 为不走 registerToolOptions 的快捷命令（upload / CI 自定义命令）注册
- * 由环境变量自动注入的 path 参数，使其可被显式覆盖。
- * - repo：始终注册，未传时由 autoPath 从 CNB_REPO_SLUG 回填
- * - number：仅在命令所属接口真的需要 number 时注册，避免帮助里出现「有选项但静默无效」
+ * 由环境变量自动注入的 path 参数，使其可被显式覆盖（未传时由 autoPath 从环境变量回填）。
+ * - repo：所有快捷命令都注册
+ * - number：对所有快捷命令都注册，但只有接口真的消费 number 时才有意义
+ *
+ * number 的注册遵循「统一接口形态」：Issue 与 PR 两侧的快捷命令参数保持一致，
+ * 便于 NPC 用同一套写法（`--repo x/y --number 99`）在两种场景间迁移。
+ * 消费方（upload / CI 分支）只取自己需要的字段，多传不会改变任何请求。
  */
-function registerAutoInjectedPathOptions(cmd: Command, needNumber?: boolean): void {
+function registerAutoInjectedPathOptions(cmd: Command): void {
   cmd.option('--repo <string>', '仓库名称（可选，默认取 CNB_REPO_SLUG）');
-  if (needNumber) {
-    cmd.option('--number <string>', '编号（可选，默认取 CNB_ISSUE_IID / CNB_PULL_REQUEST_IID）');
-  }
+  cmd.option('--number <string>', '编号（可选，默认取 CNB_ISSUE_IID / CNB_PULL_REQUEST_IID）');
 }
 
 /**
@@ -201,19 +203,18 @@ export function registerModuleCommands(program: Command): void {
       // 按命令类别注册选项：upload / ci 自定义 / 普通 swagger 命令
       if (shortcut.upload) {
         shortcutCmd.requiredOption('--file <string>', '本地文件路径。必填。');
-        // 是否需要 number 由接口本身决定，而非 shortcut.repoOnly：
+        // --number 一律注册，但只有 issue 评论上传会消费：
         // - post-issue-comment-*-asset-upload-url（issue 评论上传）：path 为 repo + number
         // - post-asset-group（创建 issue 时上传）：path 只有 repo，number 传了也会被忽略
         // - pull 侧 upload-files / upload-imgs：按仓库维度上传，同样不需要 number
-        const needNumber = shortcut.realTool !== 'post-asset-group' && !shortcut.repoOnly;
-        registerAutoInjectedPathOptions(shortcutCmd, needNumber);
+        registerAutoInjectedPathOptions(shortcutCmd);
       } else if (
         shortcut.realTool === '__get-ci-logs__' ||
         shortcut.realTool === '__get-ci-timing__'
       ) {
         shortcutCmd.option('--sn <string>', '构建号（可选，默认自动从环境变量或 PR 状态获取）');
-        // CI 命令按仓库维度查询，允许显式覆盖环境变量中的仓库
-        shortcutCmd.option('--repo <string>', '仓库名称（可选，默认取 CNB_REPO_SLUG）');
+        // CI 命令按 PR 维度查询，同样注册 --number 保持两侧参数形态一致
+        registerAutoInjectedPathOptions(shortcutCmd);
       } else {
         registerToolOptions(shortcutCmd, moduleName, shortcut.realTool, true);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cnbcool/cnb-api-generate",
-  "version": "2.20.1",
+  "version": "2.21.0",
   "main": "./built/index.js",
   "module": "./src/index.ts",
   "types": "./src/index.ts",