@coderpp/yunxiao-cli 0.1.0 → 0.1.5

package/README.md

@@ -28,7 +28,7 @@ npx @coderpp/yunxiao-cli mr list --state opened
 也可以指定版本：
 
 ```bash
-npx @coderpp/yunxiao-cli@0.1.0 mr list --json
+npx @coderpp/yunxiao-cli@0.1.4 mr list --output json
 ```
 
 包内的可执行命令名仍然是 `yunxiao`，全局安装后可这样使用：
@@ -38,6 +38,37 @@ npm install -g @coderpp/yunxiao-cli
 yunxiao mr list --state opened
 ```
 
+## CI/CD
+
+仓库包含两个 GitHub Actions 工作流：
+
+- `CI`：在 pull request 和 `main` 分支 push 时运行 `npm ci`、`npm test`、`npm run pack:dry-run`。
+- `Publish`：在推送 `v*.*.*` tag 或手动触发时发布 npm 包。
+
+自动发布使用 npm Trusted Publishing，不需要在 GitHub 保存长期 npm token。npm 包设置中需要配置 Trusted Publisher：
+
+- Provider：GitHub Actions
+- Organization or user：`coderpp`
+- Repository：`yunxiao-cli`
+- Workflow filename：`publish.yml`
+- Environment name：留空
+
+Trusted Publishing 要求发布环境使用 npm CLI 11.5.1 或更高版本，workflow 的发布 job 使用 Node.js 24。
+
+发布新版本的流程：
+
+```bash
+npm version patch
+git push origin main --follow-tags
+```
+
+如果手动创建 tag，需要确保 tag 和 `package.json` 版本一致，例如：
+
+```bash
+npm version 0.1.1
+git push origin main v0.1.1
+```
+
 ## 配置
 
 不要把个人访问令牌写入代码或提交到仓库。建议通过环境变量提供：
@@ -66,7 +97,7 @@ node dist/src/index.js mr list --state opened --project-ids 2813489 --per-page 2
 输出 JSON：
 
 ```bash
-node dist/src/index.js mr list --state opened --json
+node dist/src/index.js mr list --state opened --output json
 ```
 
 评审通过指定合并请求：
@@ -101,6 +132,24 @@ node dist/src/index.js mr tree 2813489 12 \
 node dist/src/index.js mr patches 2813489 12
 ```
 
+## 输出格式
+
+所有会输出 API 结果的命令都支持 `--output`：
+
+```bash
+node dist/src/index.js mr list --output table
+node dist/src/index.js mr list --output json
+node dist/src/index.js mr review 2813489 12 --output table
+node dist/src/index.js mr patches 2813489 12 --output json
+```
+
+支持的格式：
+
+- `table`：普通表格文本，默认值。
+- `json`：格式化 JSON。
+
+`--json` 仍然可用，等价于 `--output json`。
+
 ## 参数补充
 
 `repositoryId` 可以是代码库 ID，也可以是仓库完整路径，工具会自动做 URL 编码。

package/dist/src/cli.js

@@ -1,5 +1,6 @@
 import { YunxiaoClient } from "./client.js";
 const mergeTypes = new Set(["ff-only", "no-fast-forward", "squash", "rebase"]);
+const outputFormats = new Set(["table", "json"]);
 export async function runCli(args = process.argv.slice(2), env = process.env, io = {}) {
     const stdout = io.stdout ?? ((text) => process.stdout.write(text));
     const stderr = io.stderr ?? ((text) => process.stderr.write(text));
@@ -13,11 +14,12 @@ export async function runCli(args = process.argv.slice(2), env = process.env, io
         if (scope !== "mr" || !command) {
             throw new Error(`Unknown command: ${parsed.positionals.join(" ")}`);
         }
+        const outputFormat = outputFormatFromFlags(parsed.flags);
         const client = createClient(parsed.flags, env, io.fetcher);
         let result;
         if (command === "list") {
             result = await client.listChangeRequests(listOptions(parsed.flags));
-            printResult(result, Boolean(parsed.flags.json), stdout);
+            printResult(result, outputFormat, stdout);
             return 0;
         }
         if (!repositoryId || !localIdRaw) {
@@ -53,7 +55,7 @@ export async function runCli(args = process.argv.slice(2), env = process.env, io
             default:
                 throw new Error(`Unknown mr command: ${command}`);
         }
-        printResult(result, Boolean(parsed.flags.json), stdout);
+        printResult(result, outputFormat, stdout);
         return 0;
     }
     catch (error) {
@@ -126,8 +128,19 @@ function requireConfirmation(flags) {
         throw new Error("This command changes repository state. Re-run with --yes after you have reviewed the merge request.");
     }
 }
-function printResult(result, asJson, stdout) {
-    if (asJson) {
+function outputFormatFromFlags(flags) {
+    const requestedOutput = optionalString(flags.output);
+    if (flags.json && requestedOutput && requestedOutput !== "json") {
+        throw new Error("--json cannot be combined with --output table.");
+    }
+    const output = flags.json ? "json" : requestedOutput ?? "table";
+    if (!outputFormats.has(output)) {
+        throw new Error(`Invalid --output: ${output}. Supported formats: table, json.`);
+    }
+    return output;
+}
+function printResult(result, outputFormat, stdout) {
+    if (outputFormat === "json") {
         stdout(`${JSON.stringify(result, null, 2)}\n`);
         return;
     }
@@ -135,22 +148,50 @@ function printResult(result, asJson, stdout) {
         stdout(formatTable(result));
         return;
     }
-    stdout(`${JSON.stringify(result, null, 2)}\n`);
+    if (isRecord(result)) {
+        stdout(formatKeyValueTable(result));
+        return;
+    }
+    if (result === null || result === undefined) {
+        stdout("No result.\n");
+        return;
+    }
+    stdout(`${String(result)}\n`);
 }
 function formatTable(rows) {
     if (rows.length === 0) {
         return "No records found.\n";
     }
     const normalizedRows = rows.map((row) => (isRecord(row) ? row : { value: row }));
-    const keys = ["localId", "projectId", "title", "state", "sourceBranch", "targetBranch", "detailUrl"].filter((key) => normalizedRows.some((row) => row[key] !== undefined));
-    const widths = keys.map((key) => Math.max(key.length, ...normalizedRows.map((row) => String(row[key] ?? "").length)));
+    const preferredKeys = ["localId", "projectId", "title", "state", "sourceBranch", "targetBranch", "detailUrl"].filter((key) => normalizedRows.some((row) => row[key] !== undefined));
+    const keys = preferredKeys.length > 0 ? preferredKeys : uniqueKeys(normalizedRows);
+    const widths = keys.map((key) => Math.max(key.length, ...normalizedRows.map((row) => formatCellValue(row[key]).length)));
     const line = (values) => values.map((value, index) => value.padEnd(widths[index])).join("  ");
     return [
         line(keys),
         line(keys.map((_, index) => "-".repeat(widths[index]))),
-        ...normalizedRows.map((row) => line(keys.map((key) => String(row[key] ?? ""))))
+        ...normalizedRows.map((row) => line(keys.map((key) => formatCellValue(row[key]))))
     ].join("\n") + "\n";
 }
+function uniqueKeys(rows) {
+    return Array.from(new Set(rows.flatMap((row) => Object.keys(row))));
+}
+function formatKeyValueTable(record) {
+    const rows = Object.entries(record).map(([key, value]) => ({
+        key,
+        value: formatCellValue(value)
+    }));
+    return formatTable(rows);
+}
+function formatCellValue(value) {
+    if (value === null || value === undefined) {
+        return "";
+    }
+    if (typeof value === "object") {
+        return JSON.stringify(value);
+    }
+    return String(value);
+}
 function parseLocalId(value) {
     const localId = Number(value);
     if (!Number.isInteger(localId) || localId <= 0) {
@@ -188,12 +229,17 @@ function helpText() {
     return `yunxiao - Yunxiao Codeup merge request helper
 
 Usage:
-  yunxiao mr list [--state opened] [--project-ids 2813489] [--json]
-  yunxiao mr review <repositoryId> <localId> [--comment "LGTM"]
-  yunxiao mr merge <repositoryId> <localId> --yes [--merge-type no-fast-forward]
-  yunxiao mr approve-and-merge <repositoryId> <localId> --yes [--merge-type no-fast-forward]
-  yunxiao mr tree <repositoryId> <localId> --from-patch-set-id <id> --to-patch-set-id <id>
-  yunxiao mr patches <repositoryId> <localId>
+  yunxiao mr list [--state opened] [--project-ids 2813489] [--output table|json]
+  yunxiao mr review <repositoryId> <localId> [--comment "LGTM"] [--output table|json]
+  yunxiao mr merge <repositoryId> <localId> --yes [--merge-type no-fast-forward] [--output table|json]
+  yunxiao mr approve-and-merge <repositoryId> <localId> --yes [--merge-type no-fast-forward] [--output table|json]
+  yunxiao mr tree <repositoryId> <localId> --from-patch-set-id <id> --to-patch-set-id <id> [--output table|json]
+  yunxiao mr patches <repositoryId> <localId> [--output table|json]
+
+Output:
+  --output table             Plain text table output, default
+  --output json              Pretty JSON output
+  --json                     Alias for --output json
 
 Config:
   YUNXIAO_TOKEN              Personal access token

package/package.json

@@ -1,16 +1,28 @@
 {
   "name": "@coderpp/yunxiao-cli",
-  "version": "0.1.0",
+  "version": "0.1.5",
   "description": "A CLI for Yunxiao Codeup merge request review and merge workflows.",
   "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coderpp/yunxiao-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/coderpp/yunxiao-cli/issues"
+  },
+  "homepage": "https://github.com/coderpp/yunxiao-cli#readme",
   "bin": {
     "yunxiao": "dist/src/index.js"
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
+    "pack:dry-run": "npm pack --dry-run",
     "prepack": "npm run build",
     "test": "tsc -p tsconfig.json && node --test dist/test/*.test.js"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@types/node": "^20.12.12",
     "typescript": "^5.4.5"