@ruan-cat/vercel-deploy-tool 0.8.18 → 0.9.1

package/{readme.md → README.md}

@@ -1,5 +1,9 @@
 # 阮喵喵自用的 vercel 部署工具
 
+生成满足 [Vercel Output API （v3）](https://vercel.com/docs/build-output-api)规范的目录结构，并推送到 vercel 平台内。
+
+目前仅考虑简单的静态页面，没有实现云函数等功能。
+
 ## 设计初衷
 
 - 优化冗长的 github action 写法。
@@ -183,11 +187,9 @@ jobs:
 
 ## 路线图
 
-- [x] 封装打包命令，vc deploy 命令，并赋予生产环境 url。
+- [x] 封装打包命令，`vc deploy` 命令，并赋予生产环境 url。
 - [x] 拆分配置文件到项目根目录，并实现文件读取。
-- [ ] vite 打包 typescript 成 javascript。
-- [ ] 本地运行 javascript 文件，测试。
-- [ ] github action 运行产物。
-- [ ] 封装 node 的 bin 命令，发包。
+- [x] github action 运行产物。
 - [x] github action 全局安装新开发的包，实现纯工作流的部署。
 - [x] 去其他项目，自主完成配置与部署。
+- [ ] 封装 node 的 bin 命令，发包。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vercel-deploy-tool",
-  "version": "0.8.18",
+  "version": "0.9.1",
   "description": "阮喵喵自用的vercel部署工具，用于实现复杂项目的部署。",
   "type": "module",
   "main": "./src/index.ts",
@@ -50,7 +50,7 @@
     "pathe": "^2.0.3",
     "rimraf": "^6.0.1",
     "vercel": "^41.3.0",
-    "@ruan-cat/utils": "^4.6.0"
+    "@ruan-cat/utils": "^4.7.0"
   },
   "devDependencies": {
     "@types/gulp": "^4.0.17",

package/src/config.ts

@@ -25,6 +25,16 @@ export type Base = {
 
 	/** 生产环境的访问url */
 	url: string[];
+
+	/**
+	 * 是否需要vercel的build命令？
+	 * @description
+	 * 某些情况下 用户已经能够准备好vercel的目录结构 不需要依赖于 `vercel build` 命令完成目录构建
+	 *
+	 * 故设计此配置 允许用户直接跳过 `vercel build` 命令
+	 * @default true
+	 */
+	isNeedVercelBuild?: boolean;
 };
 
 /**

package/src/index.ts

@@ -96,6 +96,11 @@ function getIsCopyDist(target: WithUserCommands) {
 	return target?.isCopyDist ?? true;
 }
 
+/** isNeedVercelBuild 配置 */
+function isNeedVercelBuild(target: Base) {
+	return target?.isNeedVercelBuild ?? true;
+}
+
 /** 是否需要移动文件？ */
 function isNeedCopyDist(target: DeployTarget) {
 	if (isDeployTargetsWithUserCommands(target)) {
@@ -463,12 +468,17 @@ async function main() {
 				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任务 `);
-						// consola.info(` 完成命令 ${code} `);
-						// consola.box(stdout);
 					});
 				}),
 			},