@ruan-cat/vercel-deploy-tool 0.3.0 → 0.4.0

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ruan-cat/vercel-deploy-tool",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "阮喵喵自用的vercel部署工具，用于实现复杂项目的部署。",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
-  "homepage": "https://github.com/ruan-cat/vercel-monorepo-test/tree/main/demos/vercel-deploy-tool",
+  "homepage": "https://github.com/ruan-cat/vercel-monorepo-test/tree/main/packages/vercel-deploy-tool",
   "bugs": {
     "url": "https://github.com/ruan-cat/vercel-monorepo-test/issues"
   },
@@ -44,32 +44,23 @@
     "c12": "^1.11.2",
     "commander": "^12.0.0",
     "consola": "^3.2.3",
-    "cpx": "^1.5.0",
-    "cpy": "^11.1.0",
-    "del": "^8.0.0",
-    "execa": "^9.3.1",
     "lodash-es": "4.17.21",
-    "mkdirp": "^3.0.1",
     "pathe": "^1.1.2",
     "rimraf": "^6.0.1",
     "shx": "^0.3.4",
-    "vercel": "^34.2.7",
-    "@ruan-cat/utils": "^1.2.0"
+    "vercel": "^39.1.2",
+    "@ruan-cat/utils": "^1.3.0"
   },
   "devDependencies": {
-    "@types/cpx": "^1.5.5",
     "@types/gulp": "^4.0.17",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^22.5.1",
-    "@vitest/ui": "^2.0.5",
-    "vitest": "^2.0.5"
+    "@types/node": "^22.5.1"
   },
   "scripts": {
     "—build-not-use-for-now": "tsc",
     "start": "node ./dist/index.js",
     "run": "node --import=tsx ./src/index.ts --env-path=.env.test",
     "test:config": "node --import=tsx ./tests/config.test.ts --env-path=.env.test",
-    "test:vitest": "vitest --ui --watch",
     "rm:node_modules": "rimraf node_modules"
   }
 }

package/src/config.ts

@@ -57,10 +57,17 @@ export interface WithUserCommands extends Base {
 
 	/**
 	 * 部署输出路径
+	 *
+	 * @version 1
 	 * @description
 	 * 这里要填写满足 cpx 库能够识别glob语法的路径
 	 * @example docs/.vitepress/dist/**\/*
 	 * @example src/.vuepress/dist/**\/*
+	 *
+	 * @version 2
+	 * @description
+	 * 填写打包目录的路径即可。不包含glob语法。
+	 * @example docs/.vitepress/dist
 	 */
 	outputDirectory: string;
 

package/src/index.ts

@@ -1,35 +1,33 @@
 // 学习一下如何使用 https://github.com/sindresorhus/execa/blob/main/readme.md
-import fs from "node:fs";
 import { dirname, resolve } from "node:path";
-import { cp } from "node:fs/promises";
-import { execa } from "execa";
+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 { isConditionsEvery, isConditionsSome } from "@ruan-cat/utils";
-import { deleteAsync } from "del";
-import { mkdirpSync } from "mkdirp";
-import cpy from "cpy";
-import cpx from "cpx";
-
-import {
-	initVercelConfig,
-	config,
-	getConfig,
-	type Config,
-	type Base,
-	type DeployTarget,
-	type WithUserCommands,
-} from "./config";
-import { generateSimpleAsyncTask } from "./utils/simple-promise-tools";
 
 import {
+	isConditionsEvery,
+	isConditionsSome,
+	generateSimpleAsyncTask,
 	definePromiseTasks,
 	executePromiseTasks,
-	type BaseTask,
-	type ParallelTasks,
-	type QueueTasks,
-	type Task,
-} from "./utils/define-promise-tasks";
+} from "@ruan-cat/utils";
+import type { Task } from "@ruan-cat/utils";
+
+import { config, getConfig } from "./config";
+import type { Config, Base, DeployTarget, WithUserCommands } from "./config";
 
 /**
  * vercel 的空配置
@@ -49,6 +47,18 @@ export const vercelNullConfig = <const>{
 	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,
@@ -150,13 +160,16 @@ function getTargetCWDCommandArgument(deployTarget: DeployTarget) {
 }
 
 /**
- * 生成简单的 execa 函数
+ * 生成简单的执行命令函数
  * @description
  * 对 execa 做简单的包装
+ *
+ * 封装 spawnSync 函数
+ * @version 2
  */
 function generateExeca(execaSimpleParams: { command: string; parameters: string[] }) {
 	const { command, parameters } = execaSimpleParams;
-	return generateSimpleAsyncTask(() => execa(command, parameters, { shell: true }));
+	return generateSimpleAsyncTask(() => spawnSync(command, parameters, { shell: true }));
 }
 
 /**
@@ -261,7 +274,7 @@ function generateCopyDistTasks_v1(deployTarget: WithUserCommands) {
 				command,
 				parameters: [],
 			});
-			const { code, stdout } = await commandFunction();
+			const { stdout } = await commandFunction();
 			consola.info(` 执行了命令 🐓： `, command);
 			// consola.box(stdout);
 		});
@@ -291,7 +304,7 @@ function generateCopyDistTasks(deployTarget: WithUserCommands) {
 	 * 本函数仅仅拼接部分路径
 	 */
 	function joinPath<T extends string>(dir: T) {
-		const resPath = resolve(targetCWD, dir);
+		const resPath = resolve(process.cwd(), targetCWD, dir);
 		// console.log(" in joinPath => ", resPath);
 		return <`${string}${typeof targetCWD}/${T}`>resPath;
 	}
@@ -301,13 +314,13 @@ function generateCopyDistTasks(deployTarget: WithUserCommands) {
 
 	async function delVercelOutputStatic() {
 		consola.start(` 开始删除文件任务 `);
-		await deleteAsync(pathVercelOutputStatic);
+		rmSync(pathVercelOutputStatic, { recursive: true });
 		consola.success(` 删除该路径的文件： ${pathVercelOutputStatic} `);
 	}
 
 	async function createVercelOutputStatic() {
 		consola.start(` 开始创建文件夹任务 `);
-		await mkdirpSync(pathVercelOutputStatic);
+		mkdir(pathVercelOutputStatic, () => {});
 		consola.success(` 创建的新目录为： ${pathVercelOutputStatic} `);
 	}
 
@@ -315,10 +328,7 @@ function generateCopyDistTasks(deployTarget: WithUserCommands) {
 		consola.start(` 开始文件复制任务 `);
 		consola.info(` 从 ${pathOutputDirectory} 开始 `);
 		consola.info(` 复制到 ${pathVercelOutputStatic} 内`);
-		// 该写法无误 在liunx github工作流环境下，能完成文件复制。
-		await cpy(pathOutputDirectory, pathVercelOutputStatic);
-		// await cp(pathOutputDirectory, pathVercelOutputStatic, { recursive: true });
-		// await cpx.copy(pathOutputDirectory, pathVercelOutputStatic);
+		cpSync(pathOutputDirectory, pathVercelOutputStatic, { recursive: true });
 		consola.success(` 完成文件复制任务 `);
 	}
 
@@ -386,8 +396,9 @@ function generateAfterBuildTasksConfig(config: Config): Task {
 						parameters: [],
 					});
 					consola.start(` 开始用户 afterBuildTasks 命令任务 `);
-					const { code, stdout } = await userCommand();
-					consola.success(` 完成用户 afterBuildTasks 命令任务 ${code} `);
+					const { stdout } = await userCommand();
+					// consola.success(` 完成用户 afterBuildTasks 命令任务 ${code} `);
+					consola.success(` 完成用户 afterBuildTasks 命令任务 `);
 					// consola.box(stdout);
 				});
 			}),
@@ -429,9 +440,9 @@ async function main() {
 					return generateSimpleAsyncTask(async () => {
 						const build = generateBuildTask(deployTarget);
 						consola.start(` 开始build任务 `);
-						const { code, stdout } = await build();
+						const { stdout } = await build();
 						consola.success(` 完成build任务 `);
-						consola.info(` 完成命令 ${code} `);
+						// consola.info(` 完成命令 ${code} `);
 						// consola.box(stdout);
 					});
 				}),
@@ -463,8 +474,9 @@ async function main() {
 													parameters: [],
 												});
 												consola.start(` 开始用户命令任务 `);
-												const { code, stdout } = await userCommand();
-												consola.success(` 完成用户命令任务 ${code} `);
+												const { stdout } = await userCommand();
+												// consola.success(` 完成用户命令任务 ${code} `);
+												consola.success(` 完成用户命令任务 `);
 												// consola.box(stdout);
 											});
 										}),
@@ -499,7 +511,8 @@ async function main() {
 							generateSimpleAsyncTask(async () => {
 								const deploy = generateDeployTask(deployTarget);
 								consola.start(` 开始部署任务 `);
-								const { stdout: vercelUrl } = await deploy();
+								const { stdout } = await deploy();
+								const vercelUrl = stdout.toString();
 								consola.success(` 完成部署任务 检查生成的url为 \n `);
 								consola.box(vercelUrl);
 								return vercelUrl;
@@ -512,8 +525,8 @@ async function main() {
 									return generateSimpleAsyncTask(async (vercelUrl: string) => {
 										const alias = generateAliasTask(vercelUrl, userUrl);
 										consola.start(` 开始别名任务 `);
-										const { stdout, command } = await alias();
-										consola.success(` 执行了： ${command} `);
+										const { stdout } = await alias();
+										// consola.success(` 执行了： ${command} `);
 										consola.success(` 完成别名任务 可用的别名地址为 \n`);
 										consola.box(`https://${userUrl}`);
 									});

package/tsconfig.json

@@ -1,5 +1,10 @@
 {
 	"extends": "../../tsconfig.base.json",
+	"references": [
+		{
+			"path": "../../tsconfig.md.json"
+		}
+	],
 	"compilerOptions": {
 		"target": "ESNext",
 		"module": "ESNext",
@@ -31,7 +36,7 @@
 	"include": [
 		"./src/**/*.ts",
 		"./tests/**/*.test.ts",
-		"./tests/**/*.ts"
+		"./tests/**/*.ts",
 		// "src",
 		// "tests"
 	]

package/src/utils/define-promise-tasks.ts

@@ -1,138 +0,0 @@
-import {
-	type SimpleAsyncTask,
-	type SimpleAsyncTaskWithType,
-	generateSimpleAsyncTask,
-	runPromiseByConcurrency,
-	runPromiseByQueue,
-} from "./simple-promise-tools";
-
-export const taskTypes = <const>["single", "parallel", "queue"];
-
-export type TaskType = (typeof taskTypes)[number];
-
-export interface BaseTask {
-	/** 任务类型 */
-	type: TaskType;
-}
-
-// type Task = SimpleAsyncTaskWithType | TasksConfig;
-export type Task = SimpleAsyncTask | TasksConfig;
-
-export interface SingleTasks extends BaseTask {
-	type: "single";
-	tasks: Task;
-}
-
-export interface ParallelTasks extends BaseTask {
-	type: "parallel";
-	tasks: Task[];
-}
-
-export interface QueueTasks extends BaseTask {
-	type: "queue";
-	tasks: Task[];
-}
-
-export type TasksConfig = SingleTasks | ParallelTasks | QueueTasks;
-
-export type PromiseTasksConfig = TasksConfig;
-
-function isSingleTasks(config: TasksConfig): config is SingleTasks {
-	return config.type === "single";
-}
-
-function isParallelTasks(config: TasksConfig): config is ParallelTasks {
-	return config.type === "parallel";
-}
-
-function isQueueTasks(config: TasksConfig): config is QueueTasks {
-	return config.type === "queue";
-}
-
-function isSimpleAsyncTask(config: Task): config is SimpleAsyncTask {
-	return typeof config === "function";
-}
-
-function isTasksConfig(config: Task): config is TasksConfig {
-	return typeof config === "object";
-}
-
-/**
- * 定义异步任务对象
- * @description
- * 这个对象是一揽子异步任务的配置
- */
-export function definePromiseTasks(config: TasksConfig) {
-	return config;
-}
-
-/**
- * @private 一个工具函数 用于生成异步函数数组
- * @deprecated 在处理串行任务时 疑似有故障
- */
-function getPromises(tasks: Task[]): ((...args: any) => Promise<any>)[] {
-	return tasks.map((task) => {
-		return async function (...args: any) {
-			if (isSimpleAsyncTask(task)) {
-				return await task(...args);
-			} else {
-				return await executePromiseTasks(task);
-			}
-		};
-	});
-}
-
-/**
- * 执行异步函数对象
- */
-export async function executePromiseTasks(
-	config: TasksConfig,
-	/**
-	 * 上一次递归执行时提供的参数
-	 * @description
-	 * 考虑到递归函数 这里提供了一个参数 用于传递上一次递归执行的结果
-	 */
-	lastParams: any = null,
-): Promise<any> {
-	if (isSingleTasks(config)) {
-		if (isSimpleAsyncTask(config.tasks)) {
-			// 实际执行的 tasks 往往是无参函数 这里为了保险，故主动传递参数
-			return await config.tasks(lastParams);
-		}
-
-		return await executePromiseTasks(config.tasks, lastParams);
-	}
-
-	if (isParallelTasks(config)) {
-		return await Promise.all(
-			config.tasks.map((task) => {
-				if (isSimpleAsyncTask(task)) {
-					// console.log(` 并行任务遇到单独的异步函数 `);
-					return task(lastParams);
-				}
-
-				// console.log(` 并行任务遇到嵌套结构 `);
-				return executePromiseTasks(task, lastParams);
-			}),
-		);
-	}
-
-	if (isQueueTasks(config)) {
-		let res: Awaited<any>;
-		for await (const task of config.tasks) {
-			if (isSimpleAsyncTask(task)) {
-				// console.log(` 串行任务遇到单独的异步函数 `);
-
-				res = await task(lastParams);
-				lastParams = res;
-				// console.log(` 串行任务 单独 res `, res);
-			} else {
-				res = await executePromiseTasks(task, lastParams);
-				lastParams = res;
-				// console.log(` 串行任务 配置 res `, res);
-			}
-		}
-
-		return res;
-	}
-}

package/src/utils/simple-promise-tools.ts

@@ -1,94 +0,0 @@
-import { consola } from "consola";
-import { uniqueId } from "lodash-es";
-
-export function wait(time: number) {
-	return new Promise<void>((resolve) => {
-		setTimeout(() => {
-			resolve();
-		}, time);
-	});
-}
-
-const getCounter = () => uniqueId();
-
-/** 创建简单的异步任务 */
-export function generateSimpleAsyncTask<T extends (...args: any) => any>(func: T) {
-	const taskId = getCounter();
-
-	return function (...args: any) {
-		// consola.info(` 这是第 ${taskId} 个异步任务 `);
-		// consola.start(" 这里是新创建的异步函数 检查参数： ", ...args);
-
-		return new Promise<ReturnType<T>>((resolve, reject) => {
-			// consola.start(" 内部promise 检查参数： ", ...args);
-			resolve(func(...args));
-		});
-	};
-}
-
-export type SimpleAsyncTask = ReturnType<typeof generateSimpleAsyncTask>;
-
-/** @deprecated */
-export type SimpleAsyncTaskWithType = <T = any>(...args: any) => Promise<T>;
-
-export const initFlag = <const>"initFlag";
-
-/**
- * 以队列串行的形式 串行运行异步函数
- * @see https://github.com/ascoders/weekly/blob/master/前沿技术/77.精读《用%20Reduce%20实现%20Promise%20串行执行》.md
- * @version 1
- */
-async function runPromiseByQueueV1<T>(promises: ((...args: any) => Promise<T>)[]) {
-	promises.reduce(
-		async function (previousPromise, nextPromise, currentIndex) {
-			const response = await previousPromise;
-			// consola.log(` reduce串行函数 currentIndex= ${currentIndex} res =`, response);
-			return await nextPromise(response);
-		},
-		Promise.resolve(initFlag) as Promise<any>,
-	);
-}
-
-/**
- * 以队列串行的形式 串行运行异步函数
- * @version 2
- */
-export async function runPromiseByQueue<T>(promises: ((...args: any) => Promise<T>)[]) {
-	let response: typeof initFlag | Awaited<T> = initFlag;
-	for await (const promise of promises) {
-		response = await promise(response);
-	}
-}
-
-/**
- * 以并行的形式 并发运行异步函数
- */
-export async function runPromiseByConcurrency<T>(promises: ((...args: any) => Promise<T>)[]) {
-	await Promise.all(promises.map((promise) => promise()));
-}
-
-export const testPromises = [
-	generateSimpleAsyncTask(async function (params) {
-		await wait(400);
-		consola.log(" 这里是 1 号函数 ");
-		consola.log(" 查看上一个函数返回过来的参数： ", params);
-		return 1;
-	}),
-
-	generateSimpleAsyncTask(async function (params) {
-		await wait(500);
-		consola.log(" 这里是 2 号函数 ");
-		consola.log(" 查看上一个函数返回过来的参数： ", params);
-		return 2;
-	}),
-
-	generateSimpleAsyncTask(async function (params) {
-		await wait(500);
-		consola.log(" 这里是 3 号函数 ");
-		consola.log(" 查看上一个函数返回过来的参数： ", params);
-		return 3;
-	}),
-];
-
-// 测试队列函数的传参能力 发现这里是可以实现传参的
-// runPromiseByQueue(testPromises);