@cnbcool/cnb-api-generate 2.3.5 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,6 +9,13 @@ import { refreshAccessToken } from './refresh-token';
9
9
  * 刷新失败或无 refresh_token 时终止进程并提示用户重新登录。
10
10
  */
11
11
  export async function resolveToken(): Promise<string> {
12
+ // 环境变量优先 CodeBuddy
13
+ if (process.env.CNB_TOKEN_FOR_CODEBUDDY) {
14
+ if (!process.env.CNB_NPC_SLUG && process.env.CNB_NPC_NAME === 'CodeBuddy') {
15
+ return process.env.CNB_TOKEN_FOR_CODEBUDDY;
16
+ }
17
+ }
18
+
12
19
  // 环境变量优先,不做过期判断
13
20
  if (process.env.CNB_TOKEN) {
14
21
  return process.env.CNB_TOKEN;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cnbcool/cnb-api-generate",
3
- "version": "2.3.5",
3
+ "version": "2.4.0",
4
4
  "main": "./built/index.js",
5
5
  "module": "./src/index.ts",
6
6
  "types": "./src/index.ts",
@@ -10,49 +10,45 @@ description: CNB OpenAPI 交互能力,支持仓库、Issue、PR、流水线、
10
10
  ## 快捷命令
11
11
 
12
12
  issues:
13
- - `<$CNB_CLI_CMD$> issues get` — 获取 Issue 详情
14
- - `<$CNB_CLI_CMD$> issues list-comments` — 列出 Issue 评论
15
- - `<$CNB_CLI_CMD$> issues comment --body '内容'` — 发表 Issue 评论
16
- - `<$CNB_CLI_CMD$> issues close` — 关闭 Issue
17
- - `<$CNB_CLI_CMD$> issues open` — 打开 Issue
18
- - `<$CNB_CLI_CMD$> issues list-labels` — 列出 Issue 标签
19
- - `<$CNB_CLI_CMD$> issues add-labels --labels bug --labels feature` — 添加 Issue 标签
20
- - `<$CNB_CLI_CMD$> issues list-assignees` — 查看 Issue 处理人
21
- - `<$CNB_CLI_CMD$> issues add-assignees --assignees username` — 添加 Issue 处理人
22
- - `<$CNB_CLI_CMD$> issues upload-file --file 文件路径` — 上传文件到 Issue
23
- - `<$CNB_CLI_CMD$> issues upload-image --file 图片路径` — 上传图片到 Issue
13
+ - `<$CNB_CLI_CMD$> issues get` — 获取当前 Issue 详情
14
+ - `<$CNB_CLI_CMD$> issues list-comments` — 列出当前 Issue 评论
15
+ - `<$CNB_CLI_CMD$> issues comment --body '内容'` — 发表评论到当前 Issue
16
+ - `<$CNB_CLI_CMD$> issues close` — 关闭当前 Issue
17
+ - `<$CNB_CLI_CMD$> issues open` — 打开当前 Issue
18
+ - `<$CNB_CLI_CMD$> issues list-labels` — 列出当前 Issue 标签
19
+ - `<$CNB_CLI_CMD$> issues add-labels --labels bug --labels feature` — 添加标签到当前 Issue
20
+ - `<$CNB_CLI_CMD$> issues list-assignees` — 查看当前 Issue 处理人
21
+ - `<$CNB_CLI_CMD$> issues add-assignees --assignees username` — 添加处理人到当前 Issue
22
+ - `<$CNB_CLI_CMD$> issues upload-file --file 文件路径` — 上传文件到当前 Issue
23
+ - `<$CNB_CLI_CMD$> issues upload-image --file 图片路径` — 上传图片到当前 Issue
24
24
 
25
25
  pulls:
26
- - `<$CNB_CLI_CMD$> pulls get` — 获取 PR 详情
27
- - `<$CNB_CLI_CMD$> pulls list-files` — 列出 PR 变更文件
28
- - `<$CNB_CLI_CMD$> pulls list-commits` — 列出 PR 提交记录
29
- - `<$CNB_CLI_CMD$> pulls list-comments` — 列出 PR 评论
26
+ - `<$CNB_CLI_CMD$> pulls get` — 获取当前 PR 详情
27
+ - `<$CNB_CLI_CMD$> pulls list-files` — 列出当前 PR 变更文件
28
+ - `<$CNB_CLI_CMD$> pulls list-commits` — 列出当前 PR 提交记录
29
+ - `<$CNB_CLI_CMD$> pulls list-comments` — 列出当前 PR 评论
30
30
  - `<$CNB_CLI_CMD$> pulls comment --body '内容'` — 发表 PR 评论
31
- - `<$CNB_CLI_CMD$> pulls list-labels` — 列出 PR 标签
32
- - `<$CNB_CLI_CMD$> pulls add-labels --labels ready --labels approved` — 添加 PR 标签
33
- - `<$CNB_CLI_CMD$> pulls check-status` — 查看 CI 状态
34
- - `<$CNB_CLI_CMD$> pulls list-reviews` — 查看评审列表
35
- - `<$CNB_CLI_CMD$> pulls list-assignees` — 查看 PR 处理人
36
- - `<$CNB_CLI_CMD$> pulls upload-file --file 文件路径` 上传文件到 PR
37
- - `<$CNB_CLI_CMD$> pulls upload-image --file 图片路径`上传图片到 PR
38
- - `<$CNB_CLI_CMD$> pulls get-ci-logs`获取 PR 失败构建的 CI 日志和耗时分析(可选 --sn 指定构建号)
31
+ - `<$CNB_CLI_CMD$> pulls list-labels` — 列出当前 PR 标签
32
+ - `<$CNB_CLI_CMD$> pulls add-labels --labels ready --labels approved` — 添加标签到当前 PR
33
+ - `<$CNB_CLI_CMD$> pulls check-status` — 获取当前 PR 的 CI 状态
34
+ - `<$CNB_CLI_CMD$> pulls get-ci-logs` — 获取当前 PR 的 CI 构建日志
35
+ - `<$CNB_CLI_CMD$> pulls list-reviews` — 查看当前当前的评审列表
36
+ - `<$CNB_CLI_CMD$> pulls list-assignees`查看当前 PR 处理人
37
+ - `<$CNB_CLI_CMD$> pulls upload-file --file 文件路径`上传文件到当前 PR
38
+ - `<$CNB_CLI_CMD$> pulls upload-image --file 图片路径` 上传图片到当前 PR
39
39
 
40
40
  注意事项:
41
- - **路径参数自动注入**:仓库 slug、Issue/PR 编号优先从环境变量自动获取,无需额外传入任何其他参数
42
- - **默认只输出摘要**:会精简响应输出结果,只返回核心字段。加 `--verbose` 输出完整数据。
41
+ - **路径参数自动识别**:快捷命令中的 Issue/PR 编号会自动从环境变量识别,无需额外传递。
42
+ - **默认只输出摘要**:默认会精简响应输出结果,只返回核心字段。添加 `--verbose` 输出完整数据。
43
43
  - **多行文本传参使用单引号**:传递多行文本参数时,使用单引号可防止命令注入攻击,并减少不必要的转义。
44
- - **快捷命令范围** 快捷命令只能操作当前仓库的当前IssuePR,跨仓库或跨编号操作请使用其他 API 命令。
44
+ - **快捷命令范围** 快捷命令只能操作当前仓库的当前 Issue/PR,跨仓库或跨编号操作请使用其他 API 命令。
45
45
 
46
- ## 其他 API
46
+ ## 更多 API
47
47
 
48
- 快捷命令不满足时才使用
48
+ 优先使用快捷命令,不满足时才使用以下这些命令
49
49
 
50
50
  1. `<$CNB_CLI_CMD$> --help` 查看所有模块
51
51
  2. `<$CNB_CLI_CMD$> <module> --help` 查看模块下的工具列表
52
52
  3. `<$CNB_CLI_CMD$> <module> <tool> --help` 查看工具参数
53
- 4. 按参数说明执行
53
+ 4. 按帮助文档操作,禁止猜测
54
54
 
55
- ## 规则
56
-
57
- - 优先使用快捷命令,不满足时再 `--help` 逐步查找
58
- - 使用非快捷命令时,必须先 `--help` 获取帮助,禁止猜测