@ruan-cat/vercel-deploy-tool 0.12.1 → 1.0.0

package/src/core/tasks/index.ts

@@ -0,0 +1,126 @@
+import fs from "node:fs";
+import { consola } from "consola";
+import { task, executeSequential } from "../executor";
+import type { VercelDeployConfig } from "../../config/schema";
+import { isDeployTargetWithUserCommands, isNeedVercelBuild, getIsCopyDist } from "../../utils/type-guards";
+import { VERCEL_NULL_CONFIG, VERCEL_NULL_CONFIG_PATH } from "../../utils/vercel-null-config";
+import { createLinkTask } from "./link";
+import { createBuildTask } from "./build";
+import { createAfterBuildTasks } from "./after-build";
+import { createUserCommandTasks } from "./user-commands";
+import { createCopyDistTasks } from "./copy-dist";
+import { createDeployTask } from "./deploy";
+import { createAliasTask } from "./alias";
+
+/**
+ * 生成 Vercel 空配置文件
+ * @description
+ * 在根目录创建 vercel.null.def.json 文件
+ */
+async function generateVercelNullConfig() {
+	fs.writeFileSync(VERCEL_NULL_CONFIG_PATH, JSON.stringify(VERCEL_NULL_CONFIG, null, 2));
+	consola.success(`生成 Vercel 空配置文件: ${VERCEL_NULL_CONFIG_PATH}`);
+}
+
+/**
+ * 执行 Vercel 部署工作流
+ * @description
+ * 这是整个部署流程的总入口，使用 tasuku 编排所有任务
+ *
+ * 任务执行顺序：
+ * 1. Link 阶段（并行）
+ * 2. Build 阶段（并行）
+ * 3. AfterBuild 阶段（串行）
+ * 4. UserCommands + CopyDist 阶段（并行目标，串行步骤）
+ * 5. Deploy + Alias 阶段（并行目标，串行步骤）
+ */
+export async function executeDeploymentWorkflow(config: VercelDeployConfig) {
+	// 0. 生成 Vercel 空配置文件
+	await generateVercelNullConfig();
+
+	const { deployTargets } = config;
+
+	await task("Vercel 部署工作流", async ({ task }) => {
+		// 1. Link 阶段（并行）
+		await task("1. Link 项目", async () => {
+			const linkTasks = deployTargets.map((target) => createLinkTask(config, target));
+
+			await task.group((task) => linkTasks.map((t) => task(t.name, t.fn)));
+		});
+
+		// 2. Build 阶段（并行）
+		await task("2. 构建项目", async () => {
+			const buildTasks = deployTargets.filter(isNeedVercelBuild).map((target) => createBuildTask(config, target));
+
+			if (buildTasks.length === 0) {
+				consola.warn("没有需要执行 build 的目标");
+				return;
+			}
+
+			await task.group((task) => buildTasks.map((t) => task(t.name, t.fn)));
+		});
+
+		// 3. AfterBuild 阶段（串行）
+		await task("3. 执行 AfterBuild 任务", async () => {
+			const afterBuildTasks = createAfterBuildTasks(config);
+
+			await executeSequential("AfterBuild", afterBuildTasks);
+		});
+
+		// 4. UserCommands + CopyDist 阶段（并行目标，串行步骤）
+		await task("4. 执行用户命令与文件复制", async () => {
+			const targetTasks = deployTargets.map((target) => ({
+				name: `处理目标: ${target.targetCWD}`,
+				fn: async () => {
+					// 如果不是 userCommands 类型，跳过
+					if (!isDeployTargetWithUserCommands(target)) {
+						consola.warn(`目标 ${target.targetCWD} 不属于 userCommands 类型`);
+						return;
+					}
+
+					// 4.1 执行用户命令（串行）
+					const userCommandTasks = createUserCommandTasks(target);
+					await executeSequential(`UserCommands: ${target.targetCWD}`, userCommandTasks);
+
+					// 4.2 复制文件（串行）
+					if (getIsCopyDist(target)) {
+						const copyDistTasks = createCopyDistTasks(target);
+						await executeSequential(`CopyDist: ${target.targetCWD}`, copyDistTasks);
+					} else {
+						consola.warn(`目标 ${target.targetCWD} 不需要复制文件`);
+					}
+				},
+			}));
+
+			// 并行处理所有目标
+			await task.group((task) => targetTasks.map((t) => task(t.name, t.fn)));
+		});
+
+		// 5. Deploy + Alias 阶段（并行目标，串行步骤）
+		await task("5. 部署与设置别名", async () => {
+			const deployAliasTasks = deployTargets.map((target) => ({
+				name: `部署与别名: ${target.targetCWD}`,
+				fn: async () => {
+					// 5.1 部署
+					const deployTask = createDeployTask(config, target);
+					const deployResult = await task(deployTask.name, deployTask.fn);
+					const vercelUrl = deployResult.result;
+
+					// 5.2 设置别名（并行）
+					if (target.url && target.url.length > 0) {
+						const aliasTasks = target.url.map((userUrl) => createAliasTask(config, vercelUrl, userUrl));
+
+						await task.group((task) => aliasTasks.map((t) => task(t.name, t.fn)));
+					} else {
+						consola.warn(`目标 ${target.targetCWD} 没有配置别名`);
+					}
+				},
+			}));
+
+			// 并行处理所有目标的部署和别名
+			await task.group((task) => deployAliasTasks.map((t) => task(t.name, t.fn)));
+		});
+	});
+
+	consola.success("🎉 Vercel 部署工作流完成！");
+}

package/src/core/tasks/link.ts

@@ -0,0 +1,42 @@
+import { spawnSync } from "node:child_process";
+import { concat } from "lodash-es";
+import { consola } from "consola";
+import type { VercelDeployConfig, DeployTarget } from "../../config/schema";
+import { getVercelProjectNameArg, getVercelTokenArg, getTargetCWDArg } from "../vercel";
+
+/**
+ * 创建 Link 任务
+ * @description
+ * 旨在于封装类似于这样的命令：
+ *
+ * vc link --yes --cwd=./packages/docs --project=my-project -t TOKEN
+ */
+export function createLinkTask(config: VercelDeployConfig, target: DeployTarget) {
+	return {
+		name: `Link: ${target.targetCWD}`,
+		fn: async () => {
+			const args = concat(
+				["link"],
+				["--yes"],
+				getTargetCWDArg(target),
+				getVercelProjectNameArg(config),
+				getVercelTokenArg(config),
+			);
+
+			consola.start(`开始 link 任务: ${target.targetCWD}`);
+
+			const result = spawnSync("vercel", args, {
+				encoding: "utf-8",
+				stdio: "inherit",
+			});
+
+			if (result.error) {
+				consola.error(`link 任务失败: ${target.targetCWD}`);
+				throw result.error;
+			}
+
+			consola.success(`完成 link 任务: ${target.targetCWD}`);
+			return result.stdout;
+		},
+	};
+}

package/src/core/tasks/user-commands.ts

@@ -0,0 +1,31 @@
+import { spawnSync } from "node:child_process";
+import { consola } from "consola";
+import type { DeployTargetWithUserCommands } from "../../config/schema";
+
+/**
+ * 创建用户命令任务列表
+ * @description
+ * 执行用户自定义的命令列表
+ */
+export function createUserCommandTasks(target: DeployTargetWithUserCommands) {
+	return target.userCommands.map((command) => ({
+		name: `UserCommand: ${command}`,
+		fn: async () => {
+			consola.start(`开始用户命令任务: ${command}`);
+
+			const result = spawnSync(command, [], {
+				encoding: "utf-8",
+				stdio: "inherit",
+				shell: true,
+			});
+
+			if (result.error) {
+				consola.error(`用户命令任务失败: ${command}`);
+				throw result.error;
+			}
+
+			consola.success(`完成用户命令任务: ${command}`);
+			return result.stdout;
+		},
+	}));
+}

package/src/core/vercel.ts

@@ -0,0 +1,37 @@
+import type { VercelDeployConfig, DeployTarget } from "../config/schema";
+import { VERCEL_NULL_CONFIG_PATH } from "../utils/vercel-null-config";
+
+/**
+ * 获取 Vercel 项目名称参数
+ */
+export function getVercelProjectNameArg(config: VercelDeployConfig): string[] {
+	return ["--name", config.vercelProjectName];
+}
+
+/**
+ * 获取 Vercel scope 参数
+ */
+export function getVercelScopeArg(config: VercelDeployConfig): string[] {
+	return ["--scope", config.vercelOrgId];
+}
+
+/**
+ * 获取 Vercel token 参数
+ */
+export function getVercelTokenArg(config: VercelDeployConfig): string[] {
+	return ["--token", config.vercelToken];
+}
+
+/**
+ * 获取 Vercel 本地配置文件参数
+ */
+export function getVercelLocalConfigArg(): string[] {
+	return ["--local-config", VERCEL_NULL_CONFIG_PATH];
+}
+
+/**
+ * 获取目标工作目录参数
+ */
+export function getTargetCWDArg(target: DeployTarget): string[] {
+	return ["--cwd", target.targetCWD];
+}