@ruan-cat/vercel-deploy-tool 0.0.9 → 0.0.11

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@ruan-cat/vercel-deploy-tool",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "阮喵喵自用的vercel部署工具，用于实现复杂项目的部署。",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
-  "homepage": "https://github.com/RuanZhongNan/vercel-monorepo-test/tree/main/demos/vercel-deploy-tool",
+  "homepage": "https://github.com/ruan-cat/vercel-monorepo-test/tree/main/demos/vercel-deploy-tool",
   "bugs": {
-    "url": "https://github.com/RuanZhongNan/vercel-monorepo-test/issues"
+    "url": "https://github.com/ruan-cat/vercel-monorepo-test/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/RuanZhongNan/vercel-monorepo-test.git",
+    "url": "git+https://github.com/ruan-cat/vercel-monorepo-test.git",
     "directory": "demos/vercel-deploy-tool"
   },
   "exports": {
@@ -27,7 +27,7 @@
   "author": {
     "name": "ruan-cat",
     "email": "1219043956@qq.com",
-    "url": "https://github.com/RuanZhongNan"
+    "url": "https://github.com/ruan-cat"
   },
   "license": "MIT",
   "publishConfig": {
@@ -45,13 +45,13 @@
     "consola": "^3.2.3",
     "cpx": "^1.5.0",
     "execa": "^9.3.1",
-    "lodash-es": "^4.17.21",
+    "lodash-es": "4.17.21",
     "mkdirp": "^3.0.1",
     "pathe": "^1.1.2",
     "rimraf": "^5.0.7",
     "shx": "^0.3.4",
     "vercel": "^34.2.7",
-    "@ruan-cat/utils": "^1.0.4"
+    "@ruan-cat/utils": "^1.0.5"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",

package/readme.md

@@ -17,11 +17,35 @@ pnpm i -D @ruan-cat/vercel-deploy-tool@latest
 
 ## 环境要求
 
-- node >=22.6.0
+- node >=20.15.1
 - pnpm >=9
 
 ## 使用教程
 
+### 增加 .gitignore 配置
+
+本工具会在根目录内默认生成一个全空配置的 vercel.null.def.json 文件，这个文件应该被忽略。
+
+后续的使用会不可避免的使用 vercel 的 api，会在你的项目内生成一个或多个.vercel 文件夹，故.vercel 文件夹也应该被忽略。
+
+```bash
+# 忽略vercel本地打包生成的文件
+.vercel
+# 忽略自动生成vercel部署配置文件
+vercel.null.def.json
+```
+
+如果你使用环境变量文件，推荐你加上 dotenv 推荐的环境变量文件忽略。
+
+```bash
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+```
+
 ### 获取 vercel 提供的 id
 
 用 [`vc link`](https://vercel.com/guides/how-can-i-use-github-actions-with-vercel) 命令获取 vercelOrgId 和 vercelProjectId。
@@ -104,16 +128,16 @@ pnpm i -D tsx
 ```yaml
 name: 自写的vercel部署工具
 env:
-	# 必须密文提供token
+  # 必须密文提供token
   VERCEL_TOKEN: ${{ secrets.vercel_token }}
-	# 可以明文提供组织id和项目id
+  # 可以明文提供组织id和项目id
   # VERCEL_ORG_ID: ${{ secrets.vercel_orgId }}
   # VERCEL_PROJECT_ID: ${{ secrets.vercel_projectId }}
 
 on:
   push:
     branches:
-			# 可以自选分支 为了避免过快耗尽vercel额度，建议只在main分支内触发部署
+      # 可以自选分支 为了避免过快耗尽vercel额度，建议只在main分支内触发部署
       - main
 
 jobs:
@@ -128,7 +152,7 @@ jobs:
         with:
           # 若项目提供了packageManager配置 这里可以不提供该配置
           # version: 9
-					# 必须安装 vercel @dotenvx/dotenvx tsx 这三个全局包
+          # 必须安装 vercel @dotenvx/dotenvx tsx 这三个全局包
           run_install: |
             - recursive: true
             - args: [--global, "vercel", "@dotenvx/dotenvx", "tsx"]
@@ -136,7 +160,7 @@ jobs:
       - name: 安装node
         uses: actions/setup-node@v4
         with:
-          node-version: 22.6.0
+          node-version: 20.15.1
           cache: pnpm
 
       - name: 检查版本
@@ -149,9 +173,9 @@ jobs:
         run: pnpm ls -g
 
       - name: 运行自写的vercel部署工具
-				# 读取环境变量
+        # 读取环境变量
         # https://dotenvx.com/docs/cis/github-actions#install-dotenvx
-				# pnpm run your-command
+        # pnpm run your-command
         run: |
           curl -sfS https://dotenvx.sh/install.sh | sh
           pnpm dotenvx run -- pnpm run deploy-vercel

package/src/index.ts

@@ -244,8 +244,8 @@ function generateCopyDistTasks(deployTarget: WithUserCommands) {
 				parameters: [],
 			});
 			const { code, stdout } = await commandFunction();
-			consola.info(` 执行了命令： `, command);
-			consola.box(stdout);
+			consola.info(` 执行了命令 🐓： `, command);
+			// consola.box(stdout);
 		});
 	});
 
@@ -311,7 +311,7 @@ function generateAfterBuildTasksConfig(config: Config): Task {
 					consola.start(` 开始用户 afterBuildTasks 命令任务 `);
 					const { code, stdout } = await userCommand();
 					consola.success(` 完成用户 afterBuildTasks 命令任务 ${code} `);
-					consola.box(stdout);
+					// consola.box(stdout);
 				});
 			}),
 		};
@@ -355,7 +355,7 @@ async function main() {
 						const { code, stdout } = await build();
 						consola.success(` 完成build任务 `);
 						consola.info(` 完成命令 ${code} `);
-						consola.box(stdout);
+						// consola.box(stdout);
 					});
 				}),
 			},
@@ -388,7 +388,7 @@ async function main() {
 												consola.start(` 开始用户命令任务 `);
 												const { code, stdout } = await userCommand();
 												consola.success(` 完成用户命令任务 ${code} `);
-												consola.box(stdout);
+												// consola.box(stdout);
 											});
 										}),
 									},

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

@@ -125,11 +125,11 @@ export async function executePromiseTasks(
 
 				res = await task(lastParams);
 				lastParams = res;
-				console.log(` 串行任务 单独 res `, res);
+				// console.log(` 串行任务 单独 res `, res);
 			} else {
 				res = await executePromiseTasks(task, lastParams);
 				lastParams = res;
-				console.log(` 串行任务 配置 res `, res);
+				// console.log(` 串行任务 配置 res `, res);
 			}
 		}