@ruan-cat/utils 4.22.0 → 4.23.0

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "4.22.0",
+  "version": "4.23.0",
   "description": "阮喵喵工具集合。默认提供js文件，也直接提供ts文件。",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
   "bin": {
     "ruan-cat-utils": "./dist/cli/index.js",
-    "move-vercel-output-to-root": "./dist/cli/move-vercel-output-to-root.js"
+    "move-vercel-output-to-root": "./dist/cli/move-vercel-output-to-root.js",
+    "relizy-runner": "./dist/cli/relizy-runner.js"
   },
   "homepage": "https://utils.ruancat6312.top",
   "bugs": {
@@ -73,6 +74,7 @@
     "axios": "^1.13.6",
     "consola": "^3.4.2",
     "lodash-es": "^4.17.23",
+    "pkg-types": "^2.3.0",
     "pnpm-workspace-yaml": "^1.6.0",
     "tinyglobby": "^0.2.15"
   },

package/src/cli/index.ts

@@ -10,6 +10,7 @@
  *
  * 支持的子命令：
  *   move-vercel-output-to-root  将子包的 .vercel/output 搬运到 monorepo 根目录
+ *   relizy-runner               relizy 发版兼容层（Windows GNU 工具补齐 + 基线 tag 检查）
  */
 
 import consola from "consola";
@@ -17,6 +18,7 @@ import {
 	getMoveVercelOutputToRootHelpText,
 	runMoveVercelOutputToRootCli,
 } from "../node-esm/scripts/move-vercel-output-to-root/index";
+import { runRelizyRunnerCli } from "../node-esm/scripts/relizy-runner/index";
 
 const CLI_NAME = "ruan-cat-utils";
 
@@ -29,6 +31,7 @@ function printMainHelp() {
 		"",
 		"可用命令：",
 		"  move-vercel-output-to-root  将子包的 .vercel/output 搬运到 monorepo 根目录",
+		"  relizy-runner               relizy 发版兼容层（Windows GNU + 基线 tag）",
 		"",
 		"全局选项：",
 		"  -h, --help                  查看帮助信息",
@@ -38,6 +41,7 @@ function printMainHelp() {
 		`  ${CLI_NAME} move-vercel-output-to-root`,
 		`  ${CLI_NAME} move-vercel-output-to-root --dry-run`,
 		`  ${CLI_NAME} move-vercel-output-to-root --root-dir ../../..`,
+		`  ${CLI_NAME} relizy-runner release --no-publish --no-provider-release`,
 	].join("\n");
 
 	console.log(helpText);
@@ -75,6 +79,12 @@ function main() {
 			break;
 		}
 
+		case "relizy-runner": {
+			const subArgs = args.slice(1);
+			runRelizyRunnerCli(subArgs);
+			break;
+		}
+
 		default: {
 			consola.error(`未知命令：${command}`);
 			console.log("");

package/src/cli/relizy-runner.ts

@@ -0,0 +1,11 @@
+/**
+ * relizy-runner 快捷命令入口
+ *
+ * @description
+ * 本文件是 `relizy-runner` bin 命令的直接入口。
+ * 安装 @ruan-cat/utils 后，可以直接通过 `npx relizy-runner` 调用。
+ */
+
+import { runRelizyRunnerCli } from "../node-esm/scripts/relizy-runner/index";
+
+runRelizyRunnerCli();

package/src/node-esm/index.ts

@@ -2,6 +2,7 @@ export * from "./ruan-cat-pkg-info";
 
 export * from "./scripts/clean";
 export * from "./scripts/move-vercel-output-to-root";
+export * from "./scripts/relizy-runner";
 export * from "./yaml-to-md";
 
 // 导出 monorepo 相关工具函数（仅限 Node.js 环境）

package/src/node-esm/scripts/relizy-runner/index.test.ts

@@ -0,0 +1,281 @@
+import * as fs from "node:fs";
+import path from "node:path";
+import { tmpdir } from "node:os";
+import { afterEach, beforeEach, describe, expect, test } from "vitest";
+
+import {
+	buildBootstrapInstructions,
+	getRelizyRunnerHelpText,
+	getWorkspacePackages,
+	parseRelizyRunnerCliArgs,
+	shouldCheckIndependentBootstrap,
+} from "./index";
+
+function createWorkspaceFixture() {
+	const tempRoot = fs.mkdtempSync(path.join(tmpdir(), "relizy-runner-"));
+
+	fs.writeFileSync(path.join(tempRoot, "pnpm-workspace.yaml"), "packages:\n  - apps/*\n  - packages/*\n", "utf8");
+
+	const appsDir = path.join(tempRoot, "apps");
+	const packagesDir = path.join(tempRoot, "packages");
+	fs.mkdirSync(appsDir, { recursive: true });
+	fs.mkdirSync(packagesDir, { recursive: true });
+
+	const adminDir = path.join(appsDir, "admin");
+	fs.mkdirSync(adminDir, { recursive: true });
+	fs.writeFileSync(
+		path.join(adminDir, "package.json"),
+		JSON.stringify({ name: "@my-project/admin", version: "1.0.0" }),
+		"utf8",
+	);
+
+	const typeDir = path.join(appsDir, "type");
+	fs.mkdirSync(typeDir, { recursive: true });
+	fs.writeFileSync(
+		path.join(typeDir, "package.json"),
+		JSON.stringify({ name: "@my-project/type", version: "0.1.0" }),
+		"utf8",
+	);
+
+	const utilsDir = path.join(packagesDir, "utils");
+	fs.mkdirSync(utilsDir, { recursive: true });
+	fs.writeFileSync(
+		path.join(utilsDir, "package.json"),
+		JSON.stringify({ name: "@my-project/utils", version: "2.0.0" }),
+		"utf8",
+	);
+
+	return { tempRoot };
+}
+
+describe("relizy-runner", () => {
+	const temporaryDirectories = new Set<string>();
+
+	beforeEach(() => {
+		temporaryDirectories.clear();
+	});
+
+	afterEach(() => {
+		for (const tempDirectory of temporaryDirectories) {
+			fs.rmSync(tempDirectory, { force: true, recursive: true });
+		}
+	});
+
+	describe("shouldCheckIndependentBootstrap", () => {
+		test("仅 release 与 bump 需要检查基线 tag", () => {
+			expect(shouldCheckIndependentBootstrap(["release"])).toBe(true);
+			expect(shouldCheckIndependentBootstrap(["bump"])).toBe(true);
+			expect(shouldCheckIndependentBootstrap(["changelog"])).toBe(false);
+			expect(shouldCheckIndependentBootstrap(["version"])).toBe(false);
+		});
+
+		test("空参数返回 false", () => {
+			expect(shouldCheckIndependentBootstrap([])).toBe(false);
+		});
+
+		test("带额外参数时仍以第一个参数判断", () => {
+			expect(shouldCheckIndependentBootstrap(["release", "--dry-run", "--no-publish"])).toBe(true);
+			expect(shouldCheckIndependentBootstrap(["changelog", "--dry-run"])).toBe(false);
+		});
+	});
+
+	describe("buildBootstrapInstructions", () => {
+		test("缺少基线 tag 时生成明确提示", () => {
+			const instructions = buildBootstrapInstructions([
+				{ name: "@my-project/admin", version: "1.0.0" },
+				{ name: "@my-project/type", version: "0.1.0" },
+			]);
+
+			expect(instructions).toContain(
+				"[release:relizy] 检测到本仓库尚未为以下包建立基线 tag（independent 模式首次发版前需要）：",
+			);
+			expect(instructions).toContain("- @my-project/admin@1.0.0");
+			expect(instructions).toContain("- @my-project/type@0.1.0");
+			expect(instructions).toContain('git tag "@my-project/admin@1.0.0"');
+			expect(instructions).toContain('git tag "@my-project/type@0.1.0"');
+			expect(instructions).toContain('git push origin "@my-project/admin@1.0.0" "@my-project/type@0.1.0"');
+		});
+
+		test("单个包时仅生成一条 tag 命令", () => {
+			const instructions = buildBootstrapInstructions([{ name: "@my-project/admin", version: "2.0.0" }]);
+
+			expect(instructions).toContain('git tag "@my-project/admin@2.0.0"');
+			expect(instructions).toContain('git push origin "@my-project/admin@2.0.0"');
+			expect(instructions).not.toContain("@my-project/type");
+		});
+
+		test("空数组时仍包含提示前缀但无 tag 命令", () => {
+			const instructions = buildBootstrapInstructions([]);
+
+			expect(instructions).toContain(
+				"[release:relizy] 检测到本仓库尚未为以下包建立基线 tag（independent 模式首次发版前需要）：",
+			);
+			expect(instructions).not.toContain("git tag");
+		});
+	});
+
+	describe("getWorkspacePackages", () => {
+		test("从 pnpm-workspace.yaml 解析子包信息", () => {
+			const fixture = createWorkspaceFixture();
+			temporaryDirectories.add(fixture.tempRoot);
+
+			const packages = getWorkspacePackages(fixture.tempRoot);
+
+			expect(packages).toHaveLength(3);
+
+			const names = packages.map((pkg) => pkg.name);
+			expect(names).toContain("@my-project/admin");
+			expect(names).toContain("@my-project/type");
+			expect(names).toContain("@my-project/utils");
+		});
+
+		test("不存在 pnpm-workspace.yaml 时返回空数组", () => {
+			const tempRoot = fs.mkdtempSync(path.join(tmpdir(), "relizy-runner-no-yaml-"));
+			temporaryDirectories.add(tempRoot);
+
+			const packages = getWorkspacePackages(tempRoot);
+			expect(packages).toEqual([]);
+		});
+
+		test("跳过没有 package.json 的子目录", () => {
+			const fixture = createWorkspaceFixture();
+			temporaryDirectories.add(fixture.tempRoot);
+
+			const emptyDir = path.join(fixture.tempRoot, "apps", "empty-app");
+			fs.mkdirSync(emptyDir, { recursive: true });
+
+			const packages = getWorkspacePackages(fixture.tempRoot);
+			expect(packages).toHaveLength(3);
+		});
+
+		test("跳过缺少 name 或 version 的子包", () => {
+			const fixture = createWorkspaceFixture();
+			temporaryDirectories.add(fixture.tempRoot);
+
+			const noNameDir = path.join(fixture.tempRoot, "apps", "no-name");
+			fs.mkdirSync(noNameDir, { recursive: true });
+			fs.writeFileSync(path.join(noNameDir, "package.json"), JSON.stringify({ version: "1.0.0" }), "utf8");
+
+			const noVersionDir = path.join(fixture.tempRoot, "apps", "no-version");
+			fs.mkdirSync(noVersionDir, { recursive: true });
+			fs.writeFileSync(
+				path.join(noVersionDir, "package.json"),
+				JSON.stringify({ name: "@my-project/no-version" }),
+				"utf8",
+			);
+
+			const packages = getWorkspacePackages(fixture.tempRoot);
+			expect(packages).toHaveLength(3);
+			const names = packages.map((pkg) => pkg.name);
+			expect(names).not.toContain("@my-project/no-version");
+		});
+
+		test("跳过 ! 开头的排除模式和非标准 glob", () => {
+			const tempRoot = fs.mkdtempSync(path.join(tmpdir(), "relizy-runner-glob-"));
+			temporaryDirectories.add(tempRoot);
+
+			fs.writeFileSync(
+				path.join(tempRoot, "pnpm-workspace.yaml"),
+				"packages:\n  - apps/*\n  - '!apps/ignored'\n  - deep/**/*\n",
+				"utf8",
+			);
+
+			const appsDir = path.join(tempRoot, "apps");
+			fs.mkdirSync(appsDir, { recursive: true });
+
+			const appDir = path.join(appsDir, "my-app");
+			fs.mkdirSync(appDir, { recursive: true });
+			fs.writeFileSync(
+				path.join(appDir, "package.json"),
+				JSON.stringify({ name: "@test/my-app", version: "1.0.0" }),
+				"utf8",
+			);
+
+			const deepDir = path.join(tempRoot, "deep", "nested", "pkg");
+			fs.mkdirSync(deepDir, { recursive: true });
+			fs.writeFileSync(
+				path.join(deepDir, "package.json"),
+				JSON.stringify({ name: "@test/deep-pkg", version: "0.1.0" }),
+				"utf8",
+			);
+
+			const packages = getWorkspacePackages(tempRoot);
+
+			const names = packages.map((pkg) => pkg.name);
+			expect(names).toContain("@test/my-app");
+			expect(names).not.toContain("@test/deep-pkg");
+		});
+
+		test("workspace 目录不存在时静默跳过", () => {
+			const tempRoot = fs.mkdtempSync(path.join(tmpdir(), "relizy-runner-nodir-"));
+			temporaryDirectories.add(tempRoot);
+
+			fs.writeFileSync(path.join(tempRoot, "pnpm-workspace.yaml"), "packages:\n  - nonexistent/*\n", "utf8");
+
+			const packages = getWorkspacePackages(tempRoot);
+			expect(packages).toEqual([]);
+		});
+	});
+
+	describe("parseRelizyRunnerCliArgs", () => {
+		test("无参数时返回 help", () => {
+			const result = parseRelizyRunnerCliArgs([]);
+			expect(result.help).toBe(true);
+			expect(result.relizyArgs).toEqual([]);
+		});
+
+		test("--help 返回 help", () => {
+			const result = parseRelizyRunnerCliArgs(["--help"]);
+			expect(result.help).toBe(true);
+		});
+
+		test("-h 返回 help", () => {
+			const result = parseRelizyRunnerCliArgs(["-h"]);
+			expect(result.help).toBe(true);
+		});
+
+		test("正常参数透传给 relizy", () => {
+			const result = parseRelizyRunnerCliArgs(["release", "--no-publish", "--no-provider-release"]);
+			expect(result.help).toBe(false);
+			expect(result.relizyArgs).toEqual(["release", "--no-publish", "--no-provider-release"]);
+		});
+
+		test("changelog 子命令透传", () => {
+			const result = parseRelizyRunnerCliArgs(["changelog", "--dry-run"]);
+			expect(result.help).toBe(false);
+			expect(result.relizyArgs).toEqual(["changelog", "--dry-run"]);
+		});
+
+		test("bump 子命令与多参数透传", () => {
+			const result = parseRelizyRunnerCliArgs(["bump", "--patch", "--no-verify"]);
+			expect(result.help).toBe(false);
+			expect(result.relizyArgs).toEqual(["bump", "--patch", "--no-verify"]);
+		});
+	});
+
+	describe("getRelizyRunnerHelpText", () => {
+		test("帮助文本包含关键用法信息", () => {
+			const helpText = getRelizyRunnerHelpText();
+
+			expect(helpText).toContain("relizy-runner");
+			expect(helpText).toContain("release");
+			expect(helpText).toContain("changelog");
+			expect(helpText).toContain("--dry-run");
+			expect(helpText).toContain("--no-publish");
+			expect(helpText).toContain("--no-provider-release");
+		});
+
+		test("帮助文本引导用户查阅 relizy 完整参数", () => {
+			const helpText = getRelizyRunnerHelpText();
+
+			expect(helpText).toContain("npx relizy --help");
+			expect(helpText).toContain("npx relizy release --help");
+		});
+
+		test("帮助文本包含 --help 选项说明", () => {
+			const helpText = getRelizyRunnerHelpText();
+
+			expect(helpText).toContain("-h, --help");
+		});
+	});
+});