@ruan-cat/vercel-deploy-tool 0.12.2 → 1.1.0

package/src/index.ts

@@ -1,589 +1,107 @@
-// 学习一下如何使用 https://github.com/sindresorhus/execa/blob/main/readme.md
-import { dirname, resolve } from "node:path";
-import { spawnSync } from "node:child_process";
-import fs, {
-	// 文件是否存在
-	existsSync,
-	// 复制文件
-	copyFileSync,
-	// 复制目录
-	cpSync,
-	// 删除目录
-	rmSync,
-	// 新建文件夹
-	mkdir,
-} from "node:fs";
-
-import { concat, isEmpty, isUndefined } from "lodash-es";
-import { consola } from "consola";
-import gradient from "gradient-string";
-
-import {
-	isConditionsEvery,
-	isConditionsSome,
-	generateSimpleAsyncTask,
-	definePromiseTasks,
-	executePromiseTasks,
-} from "@ruan-cat/utils";
-import type { Task } from "@ruan-cat/utils";
-import { generateSpawnSync as generateSpawnSyncUtils, type SpawnSyncSimpleParams } from "@ruan-cat/utils/node-cjs";
-
-import { config, getConfig } from "./config";
-import type { Config, Base, DeployTarget, WithUserCommands } from "./config";
-
-/**
- * vercel 的空配置
- * @description
- * 设计理由
- *
- * 用于驱动vercel构建简单的目录结构，不需要额外的配置
- *
- * 该配置会被写入到 `vercel.null.def.json` 文件中
- *
- * @see https://github.com/amondnet/vercel-action#method-1---via-vercel-interface
- */
-export const vercelNullConfig = <const>{
-	framework: null,
-	buildCommand: null,
-	installCommand: null,
-	outputDirectory: null,
-	devCommand: null,
-	public: false,
-	/**
-	 * 部署后提供干净的链接
-	 * @see https://vercel.com/docs/projects/project-configuration#cleanurls
-	 *
-	 * @description
-	 * 暂无效果
-	 *
-	 * 目前在 build-output-api 中，实现cleanUrls需要手动地写入配置文件
-	 *
-	 * 成本较大，目前不做投入。
-	 */
-	cleanUrls: true,
-	git: {
-		deploymentEnabled: {
-			main: false,
-		},
-	},
-};
-
-/**
- * 空配置文件的路径
- * @description
- * 生成空配置文件。这样用户在其他项目内，就不需要自己提供vercel配置文件了。
- */
-const vercelNullConfigPath = <const>"./vercel.null.def.json";
-
-/** vercel文件api指定要求的文件目录 */
-const vercelOutputStatic = <const>".vercel/output/static";
-
-/** 初始化vercel的空配置文件 */
-async function generateVercelNullConfig() {
-	fs.writeFileSync(vercelNullConfigPath, JSON.stringify(vercelNullConfig, null, 2));
-}
-
-function isDeployTargetsBase(target: DeployTarget): target is Base {
-	return target.type === "static";
-}
-
-function isDeployTargetsWithUserCommands(target: DeployTarget): target is WithUserCommands {
-	return target.type === "userCommands";
-}
-
-/** 获得 isCopyDist 配置 */
-function getIsCopyDist(target: WithUserCommands) {
-	return target?.isCopyDist ?? true;
-}
-
-/** isNeedVercelBuild 配置 */
-function isNeedVercelBuild(target: Base) {
-	return target?.isNeedVercelBuild ?? true;
-}
-
-/** 是否需要移动文件？ */
-function isNeedCopyDist(target: DeployTarget) {
-	if (isDeployTargetsWithUserCommands(target)) {
-		const isCopyDist = getIsCopyDist(target);
-
-		/**
-		 * 每个条件都满足时 就需要移动文件
-		 * 默认总是认为要移动文件
-		 */
-		return isConditionsEvery([
-			// 如果被用户显性设置为false，不需要移动，那么就直接退出 不移动文件
-			() => isCopyDist,
-
-			// 只要用户提供了非空输出目录 就认为需要移动文件
-			// 输出目录是必填项 不做判断
-			// () => !isEmpty(target.outputDirectory),
-
-			// 只要用户提供了非空命令 就认为用户提供了有意义的build构建命令 就默认移动文件
-			// 用户不填写命令时 也可能需要移动文件 故这里不做判断
-			// () => !isEmpty(target.userCommands),
-		]);
-	} else {
-		// 不是带有用户命令的部署目标 那么就不需要移动文件
-		return false;
-	}
-}
-
-function getYesCommandArgument() {
-	return <const>["--yes"];
-}
-
-function getProdCommandArgument() {
-	return <const>["--prod"];
-}
-
-function getPrebuiltCommandArgument() {
-	return <const>["--prebuilt"];
-}
-
-/** 以命令参数数组的形式，获得项目名称 */
-function getVercelProjetNameCommandArgument() {
-	return <const>[`--project=${config.vercelProjetName}`];
-}
-
-/**
- * 以命令参数数组的形式，获得范围名称
- * @see https://vercel.com/docs/cli/global-options#scope
- *
- * 为什么传递组织id？
- * 此篇讨论内 使用了组织id
- * @see https://vercel.community/t/deployment-via-gitlab-ci-to-dev-domain/523/3
- */
-function getVercelScopeCommandArgument() {
-	return <const>[`--scope=${config.vercelOrgId}`];
-}
-
-/** 以命令参数数组的形式，获得项目token */
-function getVercelTokenCommandArgument() {
-	return <const>[`--token=${config.vercelToken}`];
-}
-
 /**
- * 以命令参数数组的形式，获得项目vercel的本地配置
+ * @ruan-cat/vercel-deploy-tool
  * @description
- * 如果用户自己提供了vercel的本地配置 那么就使用用户的。
+ * Vercel 部署工具 - 支持 monorepo 的自动化部署
  *
- * 否则就使用自己生成的文件。
+ * @author ruan-cat
+ * @license MIT
  */
-function getVercelLocalConfigCommandArgument() {
-	return <const>[`--local-config=${config?.vercelJsonPath ?? vercelNullConfigPath}`];
-}
 
-/** 以命令参数数组的形式，获得工作目录 */
-function getTargetCWDCommandArgument(deployTarget: DeployTarget) {
-	return <const>[`--cwd=${deployTarget.targetCWD}`];
-}
+// ==================== 配置系统 ====================
 
 /**
- * 生成简单的执行命令函数
+ * 定义配置的辅助函数
  * @description
- * 二次封装函数，在此仅仅负责为打印内容增加颜色。
+ * 提供类型提示和智能补全
  *
- * @version 3
- */
-function generateSpawnSync(spawnSyncSimpleParams: SpawnSyncSimpleParams) {
-	return generateSpawnSyncUtils({
-		...spawnSyncSimpleParams,
-		printCurrentCommand(params) {
-			const { command, parameters } = params;
-			const coloredCommand = gradient(["rgb(0, 153, 247)", "rgb(241, 23, 18)"])(`${command} ${parameters.join(" ")}`);
-			consola.info(` 当前运行的命令为： ${coloredCommand} \n`);
-		},
-	});
-}
-
-/**
- * 生成link任务
- * @description
- * 旨在于封装类似于这样的命令：
+ * @example
+ * ```ts
+ * import { defineConfig } from "@ruan-cat/vercel-deploy-tool";
  *
- * vc link --yes --cwd=${{env.p1}} --project=${{env.pjn}} -t ${{env.vct}}
- */
-function generateLinkTask(deployTarget: DeployTarget) {
-	return generateSpawnSync({
-		command: "vc link",
-		parameters: concat(
-			getYesCommandArgument(),
-			getTargetCWDCommandArgument(deployTarget),
-			getVercelProjetNameCommandArgument(),
-			getVercelTokenCommandArgument(),
-		),
-	});
-}
-
-/**
- * 生成build任务
- * @description
- * 旨在于封装类似于这样的命令：
- *
- * vc build --yes --prod --cwd=${{env.p1}} -A ./vercel.null.json -t ${{env.vct}}
+ * export default defineConfig({
+ *   vercelProjectName: "my-project",
+ *   vercelToken: process.env.VERCEL_TOKEN || "",
+ *   // ...
+ * });
+ * ```
  */
-function generateBuildTask(deployTarget: DeployTarget) {
-	return generateSpawnSync({
-		command: "vc build",
-		parameters: concat(
-			getYesCommandArgument(),
-			getProdCommandArgument(),
-			getTargetCWDCommandArgument(deployTarget),
-			getVercelLocalConfigCommandArgument(),
-			getVercelTokenCommandArgument(),
-		),
-	});
-}
+export { defineConfig } from "./config/define-config";
 
 /**
- * 针对单个部署目标，生成一系列移动目录的任务
+ * 加载配置
  * @description
- * 旨在于封装类似于这样的命令：
+ * 异步加载用户配置文件
  *
- * ```bash
- * # 删除目录
- * rimraf .vercel/output/static
+ * @example
+ * ```ts
+ * import { loadConfig } from "@ruan-cat/vercel-deploy-tool";
  *
- * # 新建目录
- * mkdirp .vercel/output/static
- *
- * # 复制目录到目标
- * cpx \"docs/.vitepress/dist/**\/*\" .vercel/output/static
- *
- * # 输出目录
- * shx ls -R .vercel/output/static
+ * const config = await loadConfig();
  * ```
- *
- * @version 1
- * @deprecated
- * 不再使用该方式
- *
- * 不打算在用户侧的项目内，使用 `pnpm dlx ???` 这样的命令来完成依赖安装。这样效率太低了。
  */
-function generateCopyDistTasks_v1(deployTarget: WithUserCommands) {
-	function delDirectoryCmd() {
-		return <const>`pnpm dlx rimraf ${vercelOutputStatic}`;
-	}
-
-	function createDirectoryCmd() {
-		return <const>`pnpm dlx mkdirp ${vercelOutputStatic}`;
-	}
-
-	function copyDirectoryFileCmd() {
-		return <const>`pnpm dlx cpx "${deployTarget.outputDirectory}" ${vercelOutputStatic}`;
-	}
-
-	function printDirectoryFileCmd() {
-		return <const>`pnpm dlx shx ls -R ${vercelOutputStatic}`;
-	}
-
-	function cmdPrefix() {
-		return <const>`pnpm -C=${deployTarget.targetCWD}`;
-	}
-
-	function cmdTemple<T extends (...args: any) => string, R extends ReturnType<T>>(
-		cmdFunc: T,
-	): `${ReturnType<typeof cmdPrefix>} ${R}` {
-		return `${cmdPrefix()} ${<R>cmdFunc()}`;
-	}
-
-	const delCmd = cmdTemple(delDirectoryCmd);
-	const createCmd = cmdTemple(createDirectoryCmd);
-	const copyFileCmd = cmdTemple(copyDirectoryFileCmd);
-	const printFileCmd = cmdTemple(printDirectoryFileCmd);
-
-	const copyDistTasks = (<const>[delCmd, createCmd, copyFileCmd, printFileCmd]).map((command) => {
-		return generateSimpleAsyncTask(async function () {
-			const commandFunction = generateSpawnSync({
-				command,
-				parameters: [],
-			});
-			const { stdout } = await commandFunction();
-			consola.info(` 执行了命令 🐓： `, command);
-			// consola.box(stdout);
-		});
-	});
+export { loadConfig, getConfig } from "./config/loader";
 
-	return copyDistTasks;
-}
+// ==================== 类型定义 ====================
 
 /**
- * 针对单个部署目标，生成一系列移动目录的任务
- * @description
- * 生成以下任务
- *
- * - 删除目录
- * - 新建目录
- * - 复制粘贴
+ * 导出所有类型定义
  */
-function generateCopyDistTasks(deployTarget: WithUserCommands) {
-	const targetCWD = deployTarget.targetCWD;
-	const outputDirectory = deployTarget.outputDirectory;
-
-	/**
-	 * 路径拼接工具
-	 * @private
-	 * 仅考虑为内部使用 不是通用工具
-	 *
-	 * 本函数仅仅拼接部分路径
-	 */
-	function joinPath<T extends string>(dir: T) {
-		const resPath = resolve(process.cwd(), targetCWD, dir);
-		// console.log(" in joinPath => ", resPath);
-		return <`${string}${typeof targetCWD}/${T}`>resPath;
-	}
-
-	const pathVercelOutputStatic = joinPath(vercelOutputStatic);
-	const pathOutputDirectory = joinPath(outputDirectory);
-
-	async function delVercelOutputStatic() {
-		consola.start(` 开始删除文件任务 `);
-		rmSync(pathVercelOutputStatic, { recursive: true });
-		consola.success(` 删除该路径的文件： ${pathVercelOutputStatic} `);
-	}
-
-	async function createVercelOutputStatic() {
-		consola.start(` 开始创建文件夹任务 `);
-		mkdir(pathVercelOutputStatic, () => {});
-		consola.success(` 创建的新目录为： ${pathVercelOutputStatic} `);
-	}
+export type {
+	VercelDeployConfig,
+	DeployTarget,
+	DeployTargetBase,
+	DeployTargetWithUserCommands,
+	DeployTargetType,
+} from "./types";
 
-	async function cpyDistToVercelOutputStatic() {
-		consola.start(` 开始文件复制任务 `);
-		consola.info(` 从 ${pathOutputDirectory} 开始 `);
-		consola.info(` 复制到 ${pathVercelOutputStatic} 内`);
-		cpSync(pathOutputDirectory, pathVercelOutputStatic, { recursive: true });
-		consola.success(` 完成文件复制任务 `);
-	}
-
-	const resTasks = [delVercelOutputStatic, createVercelOutputStatic, cpyDistToVercelOutputStatic].map((asyncFn) => {
-		return generateSimpleAsyncTask(asyncFn);
-	});
-
-	return resTasks;
-}
+// ==================== 核心功能 ====================
 
 /**
- * 生成alias任务
+ * 执行部署工作流
  * @description
- * 旨在于封装类似于这样的命令：
+ * 编程式调用部署流程
  *
- * vc alias set "$url1" ${{env.p1-url}} -t ${{env.vct}}
+ * @example
+ * ```ts
+ * import { executeDeploymentWorkflow, loadConfig } from "@ruan-cat/vercel-deploy-tool";
  *
- * 封装出类似的命令：
- * vercel alias set $DEPLOYMENT_URL domain2.com --token=$VERCEL_TOKEN --scope=$VERCEL_ORG_ID
- * @see https://vercel.community/t/deployment-via-gitlab-ci-to-dev-domain/523/3
+ * const config = await loadConfig();
+ * await executeDeploymentWorkflow(config);
+ * ```
  */
-function generateAliasTask(vercelUrl: string, userUrl: string) {
-	return generateSpawnSync({
-		command: `vc alias set ${vercelUrl} ${userUrl}`,
-		parameters: concat(getVercelTokenCommandArgument(), getVercelScopeCommandArgument()),
-	});
-}
+export { executeDeploymentWorkflow } from "./core/tasks";
+
+// ==================== 工具函数 ====================
 
 /**
- * 生成Deploy任务
- * @description
- * 旨在于封装类似于这样的命令：
- *
- * vc deploy --yes --prebuilt --prod --cwd=${{env.p1}} -t ${{env.vct}}
+ * Vercel 空配置
  */
-function generateDeployTask(deployTarget: DeployTarget) {
-	return generateSpawnSync({
-		command: "vc deploy",
-		parameters: concat(
-			getYesCommandArgument(),
-			getPrebuiltCommandArgument(),
-			getProdCommandArgument(),
-			getTargetCWDCommandArgument(deployTarget),
-			getVercelTokenCommandArgument(),
-		),
-		// 部署任务不需要流式输出
-		isFlow: false,
-	});
-}
+export { VERCEL_NULL_CONFIG, VERCEL_NULL_CONFIG_PATH, VERCEL_OUTPUT_STATIC } from "./utils/vercel-null-config";
 
 /**
- * 生成 afterBuildTasks 阶段的任务配置
- * @description
- * 这里返回的是具体的 Task 任务配置 不是异步函数
+ * 类型守卫
  */
-function generateAfterBuildTasksConfig(config: Config): Task {
-	const afterBuildTasks = config.afterBuildTasks;
+export {
+	isDeployTargetBase,
+	isDeployTargetWithUserCommands,
+	getIsCopyDist,
+	isNeedVercelBuild,
+} from "./utils/type-guards";
 
-	if (isConditionsSome([() => isUndefined(afterBuildTasks), () => isEmpty(afterBuildTasks)])) {
-		return {
-			type: "single",
-			tasks: generateSimpleAsyncTask(() => consola.warn(` 当前没有有意义的 afterBuildTasks 任务配置 `)),
-		};
-	} else {
-		return {
-			type: "queue",
-			tasks: afterBuildTasks!.map((command) => {
-				return generateSimpleAsyncTask(async () => {
-					const userCommand = generateSpawnSync({
-						command,
-						parameters: [],
-					});
-					consola.start(` 开始用户 afterBuildTasks 命令任务 `);
-					const { stdout } = await userCommand();
-					// consola.success(` 完成用户 afterBuildTasks 命令任务 ${code} `);
-					consola.success(` 完成用户 afterBuildTasks 命令任务 `);
-					// consola.box(stdout);
-				});
-			}),
-		};
-	}
-}
+// ==================== CLI 命令工厂 ====================
 
 /**
- * 使用异步函数定义工具的方式
- * @version 2
+ * 命令工厂函数（供编程式调用）
+ * @description
+ * 可以在代码中创建和使用命令
+ *
+ * @example
+ * ```ts
+ * import { createDeployCommand } from "@ruan-cat/vercel-deploy-tool";
+ *
+ * const deployCmd = createDeployCommand();
+ * // 使用 commander 的 API
+ * ```
  */
-async function main() {
-	await generateVercelNullConfig();
-
-	const config = getConfig();
-	const { deployTargets } = config;
-
-	const promiseTasks = definePromiseTasks({
-		type: "queue",
-
-		tasks: [
-			// 全部的link链接任务
-			{
-				type: "parallel",
-				tasks: deployTargets.map((deployTarget) => {
-					return generateSimpleAsyncTask(async () => {
-						const link = generateLinkTask(deployTarget);
-						consola.start(` 开始link任务 `);
-						await link();
-						consola.success(` 完成link任务 `);
-					});
-				}),
-			},
-
-			// 全部的build构建任务
-			{
-				type: "parallel",
-				tasks: deployTargets.map((deployTarget) => {
-					return generateSimpleAsyncTask(async () => {
-						/** 当前部署目标 是否需要 vercel 的 build 任务？ */
-						const isNeedBuildTask = isNeedVercelBuild(deployTarget);
-						if (!isNeedBuildTask) {
-							consola.warn(` 当前部署目标不需要执行build任务 `);
-							return;
-						}
-
-						const build = generateBuildTask(deployTarget);
-						consola.start(` 开始build任务 `);
-						const { stdout } = await build();
-						consola.success(` 完成build任务 `);
-					});
-				}),
-			},
-
-			// afterBuildTasks 在build命令阶段后 执行的用户命令
-			generateAfterBuildTasksConfig(config),
-
-			// 全部的用户命令任务
-			{
-				type: "parallel",
-				tasks: deployTargets.map((deployTarget) => {
-					return {
-						type: "queue",
-						tasks: [
-							// 用户命令任务
-							// 如果没有用户命令
-							!isDeployTargetsWithUserCommands(deployTarget)
-								? generateSimpleAsyncTask(() => {
-										consola.warn(" 当前目标不属于需要执行一系列用户自定义命令。 ");
-									})
-								: // 否则有用户命令
-									{
-										type: "queue",
-										tasks: deployTarget.userCommands.map((command) => {
-											return generateSimpleAsyncTask(async () => {
-												const userCommand = generateSpawnSync({
-													command,
-													parameters: [],
-												});
-												consola.start(` 开始用户命令任务 `);
-												await userCommand();
-												consola.success(` 完成用户命令任务 `);
-											});
-										}),
-									},
-
-							// 复制移动文件任务
-							// 是否需要移动文件？
-							isNeedCopyDist(deployTarget) &&
-							// 这一行判断其实是冗余的 仅用于满足下面的类型检查
-							isDeployTargetsWithUserCommands(deployTarget)
-								? {
-										type: "queue",
-										tasks: generateCopyDistTasks(deployTarget),
-									}
-								: generateSimpleAsyncTask(() => {
-										consola.warn(" 不需要移动文件 ");
-									}),
-						],
-					};
-				}),
-			},
-
-			// 全部的部署任务
-			{
-				type: "parallel",
-				tasks: deployTargets.map((deployTarget) => {
-					return {
-						type: "queue",
-						// 串行执行部署任务和别名任务
-						tasks: [
-							// 部署任务
-							generateSimpleAsyncTask(async () => {
-								const deploy = generateDeployTask(deployTarget);
-								consola.start(` 开始部署任务 `);
-								const { stdout, error, stderr } = await deploy();
-
-								if (error) {
-									consola.error(" 部署失败了 \n");
-									consola.error(error);
-									return;
-								}
-
-								const vercelUrl = stdout.toString();
-								consola.success(` 完成部署任务 检查生成的url为 \n `);
-								consola.box(vercelUrl);
-
-								consola.success(` 部署任务输出如下： \n`);
-								console.log(`\n`);
-
-								return vercelUrl;
-							}),
-
-							// 并发的别名任务
-							{
-								type: "parallel",
-								tasks: deployTarget.url.map((userUrl) => {
-									return generateSimpleAsyncTask(async (vercelUrl: string) => {
-										const alias = generateAliasTask(vercelUrl, userUrl);
-										consola.start(` 开始别名任务 `);
-										const { stdout } = await alias();
-										// consola.success(` 执行了： ${command} `);
-										consola.success(` 完成别名任务 可用的别名地址为 \n`);
-										consola.box(`https://${userUrl}`);
-									});
-								}),
-							},
-						],
-					};
-				}),
-			},
-		],
-	});
-
-	await executePromiseTasks(promiseTasks);
-}
-
-main();
+export { createDeployCommand } from "./commands/deploy";
+export { createInitCommand } from "./commands/init";