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

package/src/templates/vercel-deploy-tool.config.ts

@@ -0,0 +1,129 @@
+import { defineConfig } from "@ruan-cat/vercel-deploy-tool";
+
+/**
+ * Vercel 部署工具配置
+ * @description
+ * 配置 Vercel 部署的各项参数
+ *
+ * @see https://vercel-deploy-tool.ruancat6312.top
+ */
+export default defineConfig({
+	/**
+	 * Vercel 项目名称
+	 * @description
+	 * 在 Vercel 控制台中创建的项目名称
+	 */
+	vercelProjectName: "your-project-name",
+
+	/**
+	 * Vercel Token
+	 * @description
+	 * 从 Vercel 账户设置中获取的 API Token
+	 * 建议使用环境变量
+	 */
+	vercelToken: process.env.VERCEL_TOKEN || "",
+
+	/**
+	 * Vercel 组织 ID
+	 * @description
+	 * Vercel 组织的唯一标识符
+	 * 建议使用环境变量
+	 */
+	vercelOrgId: process.env.VERCEL_ORG_ID || "",
+
+	/**
+	 * Vercel 项目 ID
+	 * @description
+	 * Vercel 项目的唯一标识符
+	 * 建议使用环境变量
+	 */
+	vercelProjectId: process.env.VERCEL_PROJECT_ID || "",
+
+	/**
+	 * 自定义 Vercel 配置文件路径（可选）
+	 * @description
+	 * 如果需要使用自定义的 vercel.json 配置文件，可以在这里指定路径
+	 */
+	// vercelJsonPath: "./custom-vercel.json",
+
+	/**
+	 * 构建后执行的命令（可选）
+	 * @description
+	 * 在 Vercel build 阶段后执行的命令
+	 */
+	// afterBuildTasks: [
+	// 	"echo 'Build completed'",
+	// 	"pnpm run post-build",
+	// ],
+
+	/**
+	 * 部署目标
+	 * @description
+	 * 配置需要部署的项目列表
+	 * 支持 monorepo 中的多个子项目
+	 */
+	deployTargets: [
+		{
+			/**
+			 * 部署类型
+			 * @description
+			 * - "static": 静态站点
+			 * - "userCommands": 需要执行用户命令的项目
+			 */
+			type: "userCommands",
+
+			/**
+			 * 目标工作目录
+			 * @description
+			 * 项目在 monorepo 中的相对路径
+			 */
+			targetCWD: "./packages/docs",
+
+			/**
+			 * 生产环境访问 URL
+			 * @description
+			 * 部署后的自定义域名列表
+			 */
+			url: ["docs.example.com", "www.example.com"],
+
+			/**
+			 * 用户命令
+			 * @description
+			 * 构建项目的命令列表
+			 */
+			userCommands: ["pnpm build:docs"],
+
+			/**
+			 * 输出目录
+			 * @description
+			 * 构建产物的输出路径（相对于 targetCWD）
+			 */
+			outputDirectory: "docs/.vitepress/dist",
+
+			/**
+			 * 是否复制构建产物（可选）
+			 * @description
+			 * 是否将构建产物复制到 Vercel 指定的输出目录
+			 * @default true
+			 */
+			// isCopyDist: true,
+
+			/**
+			 * 是否需要 Vercel Build（可选）
+			 * @description
+			 * 是否需要执行 `vercel build` 命令
+			 * @default true
+			 */
+			// isNeedVercelBuild: true,
+		},
+
+		// 可以添加更多部署目标
+		// {
+		// 	type: "userCommands",
+		// 	targetCWD: "./packages/app",
+		// 	url: ["app.example.com"],
+		// 	userCommands: ["pnpm build"],
+		// 	outputDirectory: "dist",
+		// },
+	],
+});

package/src/types/index.ts

@@ -0,0 +1,14 @@
+/**
+ * 类型导出
+ * @description
+ * 统一导出所有公共类型定义
+ */
+
+// 配置相关类型
+export type {
+	VercelDeployConfig,
+	DeployTarget,
+	DeployTargetBase,
+	DeployTargetWithUserCommands,
+	DeployTargetType,
+} from "../config/schema";

package/src/utils/type-guards.ts

@@ -0,0 +1,33 @@
+import type { DeployTarget, DeployTargetWithUserCommands, DeployTargetBase } from "../config/schema";
+
+/**
+ * 类型守卫：判断是否为 static 类型的部署目标
+ */
+export function isDeployTargetBase(target: DeployTarget): target is DeployTargetBase {
+	return target.type === "static";
+}
+
+/**
+ * 类型守卫：判断是否为 userCommands 类型的部署目标
+ */
+export function isDeployTargetWithUserCommands(target: DeployTarget): target is DeployTargetWithUserCommands {
+	return target.type === "userCommands";
+}
+
+/**
+ * 获得 isCopyDist 配置
+ * @description
+ * 提供默认值处理
+ */
+export function getIsCopyDist(target: DeployTargetWithUserCommands): boolean {
+	return target.isCopyDist ?? true;
+}
+
+/**
+ * 获得 isNeedVercelBuild 配置
+ * @description
+ * 提供默认值处理
+ */
+export function isNeedVercelBuild(target: DeployTarget): boolean {
+	return target.isNeedVercelBuild ?? true;
+}

package/src/utils/vercel-null-config.ts

@@ -0,0 +1,46 @@
+/**
+ * Vercel 的空配置
+ * @description
+ * 设计理由：
+ *
+ * 用于驱动vercel构建简单的目录结构，不需要额外的配置
+ *
+ * 该配置会被写入到 `vercel.null.def.json` 文件中
+ *
+ * @see https://github.com/amondnet/vercel-action#method-1---via-vercel-interface
+ */
+export const VERCEL_NULL_CONFIG = {
+	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,
+		},
+	},
+} as const;
+
+/**
+ * 空配置文件的路径
+ * @description
+ * 生成空配置文件。这样用户在其他项目内，就不需要自己提供vercel配置文件了。
+ */
+export const VERCEL_NULL_CONFIG_PATH = "./vercel.null.def.json";
+
+/** Vercel文件api指定要求的文件目录 */
+export const VERCEL_OUTPUT_STATIC = ".vercel/output/static";

package/tsconfig.json

@@ -25,7 +25,9 @@
 			"@/*": ["src/*"],
 			"src/*": ["src/*"],
 			"tests/*": ["tests/*"]
-		}
+		},
+		"composite": false,
+		"incremental": false
 	},
 	"include": [
 		"./src/**/*.ts",