@ruan-cat/vercel-deploy-tool 0.9.3 → 0.10.0

package/README.md

@@ -114,7 +114,7 @@ import "@ruan-cat/vercel-deploy-tool/src/index.ts";
 		"pnpm": ">=9"
 	},
 	"scripts": {
-		"deploy-vercel": "node --import=tsx ./bin/vercel-deploy-tool.ts"
+		"deploy-vercel": "tsx ./bin/vercel-deploy-tool.ts"
 	}
 }
 ```
@@ -127,64 +127,6 @@ pnpm i -D tsx
 
 运行 `pnpm run deploy-vercel` 命令就能部署项目到 vercel 了。
 
-### 配置 github action（可选）
-
-```yaml
-name: 自写的vercel部署工具
-env:
-  # 必须密文提供token
-  VERCEL_TOKEN: ${{ secrets.vercel_token }}
-  # 可以明文提供组织id和项目id
-  # VERCEL_ORG_ID: ${{ secrets.vercel_orgId }}
-  # VERCEL_PROJECT_ID: ${{ secrets.vercel_projectId }}
-
-on:
-  push:
-    branches:
-      # 可以自选分支 为了避免过快耗尽vercel额度，建议只在main分支内触发部署
-      - main
-
-jobs:
-  Deploy-Production:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 检出分支
-        uses: actions/checkout@v4
-
-      - name: 安装pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          # 若项目提供了packageManager配置 这里可以不提供该配置
-          # version: 9
-          # 必须安装 vercel @dotenvx/dotenvx tsx 这三个全局包
-          run_install: |
-            - recursive: true
-            - args: [--global, "vercel", "@dotenvx/dotenvx", "tsx"]
-
-      - name: 安装node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.15.1
-          cache: pnpm
-
-      - name: 检查版本
-        run: |
-          node -v
-          pnpm -v
-          vc -v
-
-      - name: pnpm全局检查依赖包
-        run: pnpm ls -g
-
-      - name: 运行自写的vercel部署工具
-        # 读取环境变量
-        # https://dotenvx.com/docs/cis/github-actions#install-dotenvx
-        # pnpm run your-command
-        run: |
-          curl -sfS https://dotenvx.sh/install.sh | sh
-          pnpm dotenvx run -- pnpm run deploy-vercel
-```
-
 ## 路线图
 
 - [x] 封装打包命令，`vc deploy` 命令，并赋予生产环境 url。
@@ -192,4 +134,3 @@ jobs:
 - [x] github action 运行产物。
 - [x] github action 全局安装新开发的包，实现纯工作流的部署。
 - [x] 去其他项目，自主完成配置与部署。
-- [ ] 封装 node 的 bin 命令，发包。

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ruan-cat/vercel-deploy-tool",
-  "version": "0.9.3",
+  "version": "0.10.0",
   "description": "阮喵喵自用的vercel部署工具，用于实现复杂项目的部署。",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
-  "homepage": "https://github.com/ruan-cat/monorepo/tree/main/packages/vercel-deploy-tool",
+  "homepage": "https://vercel-deploy-tool.ruancat6312.top",
   "bugs": {
     "url": "https://github.com/ruan-cat/monorepo/issues"
   },
@@ -41,27 +41,31 @@
     "tsconfig.json"
   ],
   "dependencies": {
-    "@dotenvx/dotenvx": "^1.38.3",
-    "c12": "^3.0.2",
+    "@dotenvx/dotenvx": "^1.48.3",
+    "c12": "^3.1.0",
     "commander": "^13.1.0",
-    "consola": "^3.4.0",
+    "consola": "^3.4.2",
     "gradient-string": "^3.0.0",
     "lodash-es": "^4.17.21",
     "pathe": "^2.0.3",
     "rimraf": "^6.0.1",
-    "vercel": "^41.3.0",
-    "@ruan-cat/utils": "^4.8.1"
+    "vercel": "^41.7.8",
+    "@ruan-cat/utils": "^4.9.1"
   },
   "devDependencies": {
     "@types/gulp": "^4.0.17",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^22.13.8",
-    "execa": "^9.5.3"
+    "@types/node": "^22.16.5",
+    "execa": "^9.6.0",
+    "vitepress": "^1.6.3",
+    "@ruan-cat/vitepress-preset-config": "^0.16.1"
   },
   "scripts": {
+    "docs:dev": "vitepress dev docs --port 8080",
+    "build:docs": "vitepress build docs",
     "—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"
+    "run": "tsx ./src/index.ts --env-path=.env.test",
+    "test:config": "dotenvx run -f .env.test -f .env.test-2 -- tsx ./tests/config.test.ts"
   }
 }

package/src/config.ts

@@ -2,8 +2,9 @@ import { resolve } from "pathe";
 import { loadConfig } from "c12";
 import { config as dotenvConfig } from "@dotenvx/dotenvx";
 import { consola } from "consola";
-import { merge, isEmpty } from "lodash-es";
+import { isUndefined } from "lodash-es";
 import { program } from "commander";
+import { printFormat } from "@ruan-cat/utils";
 
 /**
  * @description
@@ -162,9 +163,21 @@ program
 	.parse();
 const options = program.opts();
 
+const envPath = options?.envPath;
+
+if (!isUndefined(envPath)) {
+	consola.warn(` 警告 ：envPath 参数已被弃用，请使用 dotenvx  命令行工具来注入环境变量 `);
+}
+
 consola.info(" 查看命令行提供的参数 ", options);
 
-/** 初始化的当前的环境变量 */
+/**
+ * 初始化的当前的环境变量
+ * @deprecated
+ * 设计变更
+ *
+ * 本函数目前不会再继续用 dotenvConfig 来获取环境变量了
+ */
 function initCurrentDotenvConfig() {
 	// 如果存在环境变量路径 就使用并读取
 	const dotenvConfigParams = options?.envPath
@@ -173,17 +186,15 @@ function initCurrentDotenvConfig() {
 			}
 		: {};
 
-	const res = dotenvConfig(
-		dotenvConfigParams,
-		// 	{
-		// 	// 具体识别的路径，会自动识别根目录下面的env文件，故这里不作处理
-		// 	 path: "../../../.env"
-		// }
-	).parsed;
-
-	consola.info(" 查看来自 @dotenvx/dotenvx 获取的环境变量： ");
-	consola.box(res);
-
+	const res = dotenvConfig().parsed;
+	// dotenvConfigParams,
+	// 	{
+	// 	// 具体识别的路径，会自动识别根目录下面的env文件，故这里不作处理
+	// 	 path: "../../../.env"
+	// }
+	// consola.info(" 查看来自 @dotenvx/dotenvx 获取的环境变量： ");
+	// consola.box(process.env);
+	// consola.success(" process.env ", process.env);
 	return res;
 }
 
@@ -213,7 +224,7 @@ async function loadUserConfig() {
 	});
 
 	consola.success(" 完成加载用户配置 ");
-	consola.box(config);
+	consola.box(printFormat(config));
 
 	return config;
 }
@@ -224,29 +235,31 @@ async function loadUserConfig() {
  * 初始化环境变量
  */
 export async function initVercelConfig() {
-	/** 当前的环境变量 */
+	/**
+	 * 当前的环境变量
+	 * @deprecated
+	 */
 	const currentDotenvConfig = initCurrentDotenvConfig();
 
 	/** 用户配置 */
 	const userConfig = await loadUserConfig();
 
-	const vercelOrgId = currentDotenvConfig!.VERCEL_ORG_ID ?? process.env.VERCEL_ORG_ID;
-	const vercelProjectId = currentDotenvConfig!.VERCEL_PROJECT_ID ?? process.env.VERCEL_PROJECT_ID;
-	const vercelToken = currentDotenvConfig!.VERCEL_TOKEN ?? process.env.VERCEL_TOKEN;
+	const vercelOrgId = process.env.VERCEL_ORG_ID;
+	const vercelProjectId = process.env.VERCEL_PROJECT_ID;
+	const vercelToken = process.env.VERCEL_TOKEN;
 
-	if (!isEmpty(vercelOrgId)) {
+	if (!isUndefined(vercelOrgId)) {
 		userConfig.vercelOrgId = vercelOrgId;
 	}
-	if (!isEmpty(vercelProjectId)) {
+	if (!isUndefined(vercelProjectId)) {
 		userConfig.vercelProjectId = vercelProjectId;
 	}
-	if (!isEmpty(vercelToken)) {
+	if (!isUndefined(vercelToken)) {
 		userConfig.vercelToken = vercelToken;
 	}
 
-	consola.success(" 完成初始化项目配置 ");
-	// 显示效果没有那么好看
-	consola.box(userConfig);
+	consola.success(` 完成初始化项目配置 `);
+	consola.box(printFormat(userConfig));
 
 	return userConfig;
 }