@coderpp/yunxiao-cli 0.1.4 → 0.1.6

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`，全局安装后可这样使用：
@@ -97,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
 ```
 
 评审通过指定合并请求：
@@ -118,6 +118,14 @@ node dist/src/index.js mr merge 2813489 12 --yes
 node dist/src/index.js mr approve-and-merge 2813489 12 --yes --merge-type squash --remove-source-branch
 ```
 
+创建发布合并请求、自动评审通过并合并：
+
+```bash
+node dist/src/index.js mr release yunxiao-cli release/1.2.3 master --yes
+```
+
+这个命令会先按仓库名称查询代码库 ID，再用当前 token 对应的用户作为评审人创建合并请求，随后评审通过并合并。合并时固定保留源分支，不会删除源分支。
+
 查询变更文件树：
 
 ```bash
@@ -132,6 +140,25 @@ 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 release yunxiao-cli release/1.2.3 master --yes --output json
+node dist/src/index.js mr patches 2813489 12 --output json
+```
+
+支持的格式：
+
+- `table`：普通表格文本，默认值。
+- `json`：格式化 JSON。
+
+`--json` 仍然可用，等价于 `--output json`。
+
 ## 参数补充
 
 `repositoryId` 可以是代码库 ID，也可以是仓库完整路径，工具会自动做 URL 编码。
@@ -140,6 +167,7 @@ node dist/src/index.js mr patches 2813489 12
 
 - `mr merge`
 - `mr approve-and-merge`
+- `mr release`
 
 这是为了避免误合并。
 

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,16 +14,30 @@ 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) {
             throw new Error(`Command mr ${command} requires <repositoryId> and <localId>.`);
         }
+        if (command === "release") {
+            requireConfirmation(parsed.flags);
+            result = await client.releaseByRepositoryName({
+                repositoryName: repositoryId,
+                sourceBranch: localIdRaw,
+                targetBranch: requiredPositional(parsed.positionals[4], "targetBranch"),
+                title: optionalString(parsed.flags.title),
+                description: optionalString(parsed.flags.description),
+                mergeType: mergeOptions(parsed.flags).mergeType
+            });
+            printResult(result, outputFormat, stdout);
+            return 0;
+        }
         const localId = parseLocalId(localIdRaw);
         switch (command) {
             case "review":
@@ -53,7 +68,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 +141,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 +161,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) {
@@ -158,6 +212,12 @@ function parseLocalId(value) {
     }
     return localId;
 }
+function requiredPositional(value, name) {
+    if (!value) {
+        throw new Error(`Missing required positional argument <${name}>.`);
+    }
+    return value;
+}
 function requiredFlag(flags, name) {
     const value = optionalString(flags[name]);
     if (!value) {
@@ -188,12 +248,18 @@ 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 release <repositoryName> <sourceBranch> <targetBranch> --yes [--title "Release"] [--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/dist/src/client.d.ts

@@ -34,12 +34,61 @@ export interface ChangeRequestTreeOptions {
     fromPatchSetId: string;
     toPatchSetId: string;
 }
+export interface ListRepositoriesOptions {
+    page?: number;
+    perPage?: number;
+    orderBy?: "created_at" | "updated_at" | "last_activity_at" | string;
+    sort?: "asc" | "desc" | string;
+    search?: string;
+    archived?: boolean;
+}
+export interface RepositorySummary {
+    id: number | string;
+    name?: string;
+    path?: string;
+    nameWithNamespace?: string;
+    pathWithNamespace?: string;
+}
+export interface CurrentUser {
+    id: string;
+    name?: string;
+    username?: string;
+    email?: string;
+}
+export interface CreateChangeRequestOptions {
+    sourceBranch: string;
+    sourceProjectId: number | string;
+    targetBranch: string;
+    targetProjectId: number | string;
+    title: string;
+    createFrom?: "WEB" | "COMMAND_LINE";
+    description?: string;
+    reviewerUserIds?: string[];
+    triggerAIReviewRun?: boolean;
+    workItemIds?: string;
+}
+export interface ReleaseByRepositoryNameOptions {
+    repositoryName: string;
+    sourceBranch: string;
+    targetBranch: string;
+    title?: string;
+    description?: string;
+    mergeType?: MergeChangeRequestOptions["mergeType"];
+}
+export interface ReleaseResult {
+    repository: RepositorySummary;
+    changeRequest: unknown;
+    review: unknown;
+    merge: unknown;
+}
 export interface ApproveAndMergeOptions extends ReviewChangeRequestOptions, MergeChangeRequestOptions {
 }
 export declare class YunxiaoApiError extends Error {
     readonly status: number;
     readonly responseBody: string;
-    constructor(message: string, status: number, responseBody: string);
+    readonly method: string;
+    readonly url: string;
+    constructor(message: string, status: number, responseBody: string, method: string, url: string);
 }
 export declare class YunxiaoClient {
     private readonly token;
@@ -49,12 +98,18 @@ export declare class YunxiaoClient {
     private readonly fetcher;
     constructor(options: YunxiaoClientOptions);
     listChangeRequests(options?: ListChangeRequestsOptions): Promise<unknown>;
+    getCurrentUser(): Promise<CurrentUser>;
+    listRepositories(options?: ListRepositoriesOptions): Promise<RepositorySummary[]>;
+    createChangeRequest(repositoryId: string, options: CreateChangeRequestOptions): Promise<unknown>;
     reviewChangeRequest(repositoryId: string, localId: number, options?: ReviewChangeRequestOptions): Promise<unknown>;
     mergeChangeRequest(repositoryId: string, localId: number, options?: MergeChangeRequestOptions): Promise<unknown>;
     approveAndMerge(repositoryId: string, localId: number, options?: ApproveAndMergeOptions): Promise<unknown>;
     getChangeRequestTree(repositoryId: string, localId: number, options: ChangeRequestTreeOptions): Promise<unknown>;
     listChangeRequestPatchSets(repositoryId: string, localId: number): Promise<unknown>;
+    releaseByRepositoryName(options: ReleaseByRepositoryNameOptions): Promise<ReleaseResult>;
     private changeRequestsPath;
+    private repositoriesPath;
+    private repositoryPath;
     private repositoryChangeRequestPath;
     private request;
 }

package/dist/src/client.js

@@ -1,10 +1,14 @@
 export class YunxiaoApiError extends Error {
     status;
     responseBody;
-    constructor(message, status, responseBody) {
+    method;
+    url;
+    constructor(message, status, responseBody, method, url) {
         super(message);
         this.status = status;
         this.responseBody = responseBody;
+        this.method = method;
+        this.url = url;
         this.name = "YunxiaoApiError";
     }
 }
@@ -30,6 +34,26 @@ export class YunxiaoClient {
     listChangeRequests(options = {}) {
         return this.request("GET", this.changeRequestsPath(), options);
     }
+    getCurrentUser() {
+        return this.request("GET", "/oapi/v1/platform/user");
+    }
+    listRepositories(options = {}) {
+        return this.request("GET", this.repositoriesPath(), options);
+    }
+    createChangeRequest(repositoryId, options) {
+        return this.request("POST", `${this.repositoryPath(repositoryId)}/changeRequests`, undefined, {
+            createFrom: options.createFrom ?? "COMMAND_LINE",
+            description: options.description,
+            reviewerUserIds: options.reviewerUserIds,
+            sourceBranch: options.sourceBranch,
+            sourceProjectId: normalizeProjectId(options.sourceProjectId),
+            targetBranch: options.targetBranch,
+            targetProjectId: normalizeProjectId(options.targetProjectId),
+            title: options.title,
+            triggerAIReviewRun: options.triggerAIReviewRun ?? false,
+            workItemIds: options.workItemIds
+        });
+    }
     reviewChangeRequest(repositoryId, localId, options = {}) {
         return this.request("POST", `${this.repositoryChangeRequestPath(repositoryId, localId)}/review`, undefined, {
             ...compactBody({
@@ -66,18 +90,67 @@ export class YunxiaoClient {
     listChangeRequestPatchSets(repositoryId, localId) {
         return this.request("GET", `${this.repositoryChangeRequestPath(repositoryId, localId)}/diffs/patches`);
     }
+    async releaseByRepositoryName(options) {
+        const [currentUser, repositories] = await Promise.all([
+            this.getCurrentUser(),
+            this.listRepositories({
+                page: 1,
+                perPage: 20,
+                search: options.repositoryName,
+                archived: false
+            })
+        ]);
+        const repository = findRepositoryByName(repositories, options.repositoryName);
+        if (!repository) {
+            throw new Error(`Repository not found by name: ${options.repositoryName}`);
+        }
+        const repositoryId = String(repository.id);
+        const title = options.title ?? `Release ${options.sourceBranch} into ${options.targetBranch}`;
+        const changeRequest = await this.createChangeRequest(repositoryId, {
+            sourceBranch: options.sourceBranch,
+            targetBranch: options.targetBranch,
+            sourceProjectId: repository.id,
+            targetProjectId: repository.id,
+            reviewerUserIds: [currentUser.id],
+            title,
+            description: options.description
+        });
+        const localId = localIdFromChangeRequest(changeRequest);
+        const review = await this.reviewChangeRequest(repositoryId, localId, {
+            reviewComment: "Approved by yunxiao-cli release workflow"
+        });
+        const merge = await this.mergeChangeRequest(repositoryId, localId, {
+            mergeType: options.mergeType,
+            removeSourceBranch: false
+        });
+        return {
+            repository,
+            changeRequest,
+            review,
+            merge
+        };
+    }
     changeRequestsPath() {
         if (this.edition === "center") {
             return `/oapi/v1/codeup/organizations/${encodePathSegment(this.organizationId ?? "")}/changeRequests`;
         }
         return "/oapi/v1/codeup/changeRequests";
     }
-    repositoryChangeRequestPath(repositoryId, localId) {
+    repositoriesPath() {
+        if (this.edition === "center") {
+            return `/oapi/v1/codeup/organizations/${encodePathSegment(this.organizationId ?? "")}/repositories`;
+        }
+        return "/oapi/v1/codeup/repositories";
+    }
+    repositoryPath(repositoryId) {
         const encodedRepositoryId = encodePathSegment(repositoryId);
         if (this.edition === "center") {
-            return `/oapi/v1/codeup/organizations/${encodePathSegment(this.organizationId ?? "")}/repositories/${encodedRepositoryId}/changeRequests/${localId}`;
+            return `/oapi/v1/codeup/organizations/${encodePathSegment(this.organizationId ?? "")}/repositories/${encodedRepositoryId}`;
         }
-        return `/oapi/v1/codeup/repositories/${encodedRepositoryId}/changeRequests/${localId}`;
+        return `/oapi/v1/codeup/repositories/${encodedRepositoryId}`;
+    }
+    repositoryChangeRequestPath(repositoryId, localId) {
+        return `${this.repositoryPath(repositoryId)}/changeRequests/${localId}`;
     }
     async request(method, path, query, body) {
         const url = new URL(`https://${this.domain}${path}`);
@@ -99,7 +172,7 @@ export class YunxiaoClient {
         const response = await this.fetcher(url.toString(), init);
         const text = await response.text();
         if (!response.ok) {
-            throw new YunxiaoApiError(`Yunxiao API request failed with HTTP ${response.status}`, response.status, text);
+            throw new YunxiaoApiError(`Yunxiao API request failed with HTTP ${response.status}: ${method} ${url.toString()}${text ? `\n${text}` : ""}`, response.status, text, method, url.toString());
         }
         if (!text) {
             return null;
@@ -116,3 +189,29 @@ function encodePathSegment(value) {
 function compactBody(body) {
     return Object.fromEntries(Object.entries(body).filter(([, value]) => value !== undefined && value !== null && value !== ""));
 }
+function normalizeProjectId(value) {
+    const numberValue = typeof value === "string" ? Number(value) : value;
+    return Number.isInteger(numberValue) ? numberValue : value;
+}
+function findRepositoryByName(repositories, repositoryName) {
+    const normalizedName = normalizeRepositoryName(repositoryName);
+    const matches = repositories.filter((repository) => [repository.name, repository.path, repository.nameWithNamespace, repository.pathWithNamespace]
+        .filter((value) => typeof value === "string")
+        .some((value) => normalizeRepositoryName(value) === normalizedName));
+    if (matches.length > 1) {
+        throw new Error(`Multiple repositories matched name: ${repositoryName}. Use a more specific path.`);
+    }
+    return matches[0];
+}
+function normalizeRepositoryName(value) {
+    return value.replace(/\s+\/\s+/g, "/").trim().toLowerCase();
+}
+function localIdFromChangeRequest(changeRequest) {
+    if (typeof changeRequest === "object" && changeRequest !== null && "localId" in changeRequest) {
+        const localId = Number(changeRequest.localId);
+        if (Number.isInteger(localId) && localId > 0) {
+            return localId;
+        }
+    }
+    throw new Error("Create change request response did not include a valid localId.");
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coderpp/yunxiao-cli",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "A CLI for Yunxiao Codeup merge request review and merge workflows.",
   "type": "module",
   "repository": {