@zhipu/zp-cli 0.0.3 → 0.0.4

package/README.md

@@ -24,11 +24,13 @@ zpc check
 `zpc deploy` 若发现无 `~/.zpc` 部署记录、但 api/web 部署目录非空或已有本项目 nginx 配置，会交互询问：
 
 1. 清空目标文件夹并覆盖（全量，旧目录备份为带时间戳的 `.bak-*`）
-2. 使用增量部署（api 保留 `public`，跳过 web）
+2. 使用增量部署（api 保留 `excludeOnIncremental` 指定项，默认 `public`；web 全量覆盖）
 3. 取消部署（默认；非交互环境同样默认取消）
 
 可选环境变量：`DEPLOY_DIR`、`DEPLOY_FORCE`；`ZPC_HOME` 覆盖 `~/.zpc`（部署状态记录）；测试可用 `ZPC_API_ROOT` / `ZPC_WEB_ROOT` / `ZPC_NGINX_DEFAULT_D` / `ZPC_DEPLOY_SKIP_RUNTIME`。
 
+`api.excludeOnIncremental`：增量部署时排除、不覆盖的目录或文件名列表，默认 `["public"]`；仅对 api 生效，指定项在增量部署后保留服务器上的既有内容。
+
 ## 部署约定
 
 `zpc.config` 中的 `projectName` 即下文 `<system-tag>`。

package/dist/cli.mjs

@@ -1,4 +1,4 @@
-import { a as findConfigFile, c as loadConfig, l as templateFileName, n as SCHEMA_FILE_NAME, o as isConfigFormat, r as configFileName, s as listConfigFiles, t as CONFIG_FORMATS } from "./config-BZc9pg7J.mjs";
+import { a as findConfigFile, c as loadConfig, l as templateFileName, n as SCHEMA_FILE_NAME, o as isConfigFormat, r as configFileName, s as listConfigFiles, t as CONFIG_FORMATS } from "./config-DzcldbBT.mjs";
 import { createRequire } from "node:module";
 import fs, { mkdtempSync, writeFileSync } from "node:fs";
 import path from "node:path";
@@ -8,7 +8,7 @@ import os, { tmpdir } from "node:os";
 import chalk from "chalk";
 import zlib from "node:zlib";
 //#region package.json
-var version = "0.0.3";
+var version = "0.0.4";
 var description = "内部单命令部署工具";
 //#endregion
 //#region src/utils/deploy-paths.ts
@@ -351,8 +351,8 @@ function deployDir(src, dest, log) {
 	}
 }
 const API_INCREMENTAL_FILES = ["package.json", "bootstrap.js"];
-/** api 增量部署：只替换 dist 与根部 package.json / bootstrap.js，不碰 public。 */
-function deployApiIncremental(src, dest, log) {
+/** api 增量部署：只替换 dist 与根部 package.json / bootstrap.js，不覆盖 excludeOnIncremental 指定项。 */
+function deployApiIncremental(src, dest, exclude, log) {
 	const distSrc = path.join(src, "dist");
 	if (!fs.existsSync(distSrc)) throw new Error(`[deploy] ${src} 缺少 dist，无法增量部署`);
 	fs.mkdirSync(dest, { recursive: true });
@@ -378,8 +378,15 @@ function deployApiIncremental(src, dest, log) {
 		if (!fs.existsSync(from)) throw new Error(`[deploy] ${src} 缺少 ${file}，无法增量部署`);
 		fs.cpSync(from, path.join(dest, file));
 	}
-	fs.mkdirSync(path.join(dest, "public"), { recursive: true });
-	log(`增量部署 ${src} -> ${dest}（更新 dist、${API_INCREMENTAL_FILES.join("、")}，保留 public）`);
+	for (const entry of exclude) {
+		const destEntry = path.join(dest, entry);
+		if (fs.existsSync(destEntry)) continue;
+		const srcEntry = path.join(src, entry);
+		if (fs.existsSync(srcEntry) && !fs.statSync(srcEntry).isDirectory()) continue;
+		fs.mkdirSync(destEntry, { recursive: true });
+	}
+	const skipText = exclude.length ? `，跳过 ${exclude.join("、")}` : "";
+	log(`增量部署 ${src} -> ${dest}（更新 dist、${API_INCREMENTAL_FILES.join("、")}${skipText}）`);
 }
 async function installAndReloadApi(name, dest, item, log) {
 	if (!fs.existsSync(path.join(dest, "package.json"))) throw new Error(`[deploy] ${dest} 缺少 package.json，无法 pnpm i`);
@@ -696,7 +703,7 @@ async function promptDeployResolution() {
 				value: "full"
 			},
 			{
-				name: "使用增量部署（api 保留 public，跳过 web）",
+				name: "使用增量部署（api 保留排除项，web 全量覆盖）",
 				value: "incremental"
 			},
 			{
@@ -844,12 +851,13 @@ async function deployKind(stagingDir, items, kind, destRoot, projectName, increm
 		if (!fs.existsSync(src)) throw new Error(`[deploy] 配置中有 ${kind}/${item.name}，但压缩包中没有对应目录`);
 		const dest = path.join(destRoot, projectName, item.name);
 		const pm2Name = `${projectName}-${item.name}`;
-		if (kind === "api" && incremental && fs.existsSync(dest)) deployApiIncremental(src, dest, log$2.info);
+		const apiItem = kind === "api" ? item : null;
+		if (apiItem && incremental && fs.existsSync(dest)) deployApiIncremental(src, dest, apiItem.excludeOnIncremental ?? [], log$2.info);
 		else {
-			if (kind === "api" && incremental && !fs.existsSync(dest)) log$2.warn(`${dest} 不存在，增量改为全量部署`);
+			if (apiItem && incremental && !fs.existsSync(dest)) log$2.warn(`${dest} 不存在，增量改为全量部署`);
 			deployDir(src, dest, log$2.info);
 		}
-		if (kind === "api" && !shouldSkipDeployRuntime()) await installAndReloadApi(pm2Name, dest, item, log$2.info);
+		if (apiItem && !shouldSkipDeployRuntime()) await installAndReloadApi(pm2Name, dest, apiItem, log$2.info);
 	}
 }
 async function runDeploy(dir, options, prompt = promptDeployResolution) {
@@ -898,12 +906,11 @@ async function runDeploy(dir, options, prompt = promptDeployResolution) {
 		} else incremental = zipIsIncremental;
 	}
 	try {
-		log$2.info(`模式: ${incremental ? "增量（api 保留 public，跳过 web）" : "全量"}`);
+		log$2.info(`模式: ${incremental ? "增量（api 保留排除项，web 全量覆盖）" : "全量"}`);
 		if (!incremental && !hadRecord) log$2.info("首次部署该项目，完成后将记录到 ~/.zpc/deploy-state.json");
 		if (force) log$2.warn("已启用 --force（允许抢占冲突的 nginx proxy）");
 		await deployKind(stagingDir, config.api, "api", getApiRoot(), config.projectName, incremental);
-		if (!incremental) await deployKind(stagingDir, config.web, "web", getWebRoot(), config.projectName, false);
-		else if (config.web?.length) log$2.warn("增量模式跳过 web 部署");
+		await deployKind(stagingDir, config.web, "web", getWebRoot(), config.projectName, false);
 	} finally {
 		fs.rmSync(stagingDir, {
 			recursive: true,
@@ -921,7 +928,7 @@ async function runDeploy(dir, options, prompt = promptDeployResolution) {
 		else if (zipIsIncremental) log$2.info("已记录部署状态，下次 deploy 将默认增量");
 	}
 	const apiCount = config.api?.length ?? 0;
-	const webCount = incremental ? 0 : config.web?.length ?? 0;
+	const webCount = config.web?.length ?? 0;
 	const prefix = `${config.projectName}/<name>`;
 	log$2.success(`完成: api ${apiCount} 个 -> ${getApiRoot()}/${prefix}，web ${webCount} 个 -> ${getWebRoot()}/${prefix}`);
 }
@@ -1016,10 +1023,9 @@ function resolveIncrementalMode(projectRoot, config, options = {}) {
 //#endregion
 //#region src/commands/pack.ts
 const log = createLogger("pack");
-function resolveProjects(root, config, incremental) {
+function resolveProjects(root, config) {
 	const projects = [];
-	const kinds = incremental ? ["api"] : ["api", "web"];
-	for (const kind of kinds) {
+	for (const kind of ["api", "web"]) {
 		const items = config[kind];
 		if (items == null) continue;
 		for (const item of items) {
@@ -1035,7 +1041,7 @@ function resolveProjects(root, config, incremental) {
 			});
 		}
 	}
-	if (projects.length === 0) throw new Error(incremental ? "[pack] 增量打包需要配置中至少有一个 api 项目" : "[pack] 配置中没有 api / web 项目");
+	if (projects.length === 0) throw new Error("[pack] 配置中没有 api / web 项目");
 	return projects;
 }
 function resolveBuildEnv(project, config) {
@@ -1101,7 +1107,8 @@ function stageApi(project, dest, incremental) {
 	copyRequiredFile(path.join(project.absPath, "package.json"), dest, "package.json");
 	copyRequiredFile(path.join(project.absPath, "bootstrap.js"), dest, "bootstrap.js");
 	if (incremental) {
-		log.warn(`api/${project.name} 增量：跳过 public`);
+		const excluded = project.excludeOnIncremental ?? [];
+		log.warn(excluded.length ? `api/${project.name} 增量：跳过 ${excluded.join("、")}` : `api/${project.name} 增量：不排除任何目录/文件`);
 		return;
 	}
 	const publicDir = path.join(project.absPath, "public");
@@ -1136,13 +1143,13 @@ async function runPack(dir, options) {
 	log.info(`项目目录: ${projectRoot}`);
 	log.info(`配置: ${file}`);
 	log.info(`项目: ${config.projectName}`);
-	log.info(`模式: ${incremental ? "增量（仅 api，不含 public）" : "全量"}`);
+	log.info(`模式: ${incremental ? "增量（api 不含排除项，web 全量）" : "全量"}`);
 	if (packMode.existingDeployDirs.length > 0) {
 		const listed = packMode.existingDeployDirs.map((dir) => path.normalize(dir)).join(", ");
-		log.warn(`无 ~/.zpc 部署记录，但检测到部署目录非空：${listed}。将按增量处理（api 保留 public，跳过 web）；若确需全量请清空部署目录并删除 deploy-state 中对应记录`);
+		log.warn(`无 ~/.zpc 部署记录，但检测到部署目录非空：${listed}。将按增量处理（api 保留排除项，web 全量覆盖）；若确需全量请清空部署目录并删除 deploy-state 中对应记录`);
 	}
 	if (options.concurrency !== void 0) log.info(`并行上限: ${options.concurrency}`);
-	const projects = resolveProjects(projectRoot, config, incremental);
+	const projects = resolveProjects(projectRoot, config);
 	await buildAll(projects, config, options);
 	stageDist(stagingDir, projectRoot, projects, incremental);
 	try {

package/dist/{config-BZc9pg7J.mjs → config-DzcldbBT.mjs}

@@ -13,6 +13,8 @@ const CONFIG_FORMATS = [
 	"cjs",
 	"json"
 ];
+/** 增量部署默认排除、不覆盖的目录/文件名。 */
+const DEFAULT_EXCLUDE_ON_INCREMENTAL = ["public"];
 function defineConfig(config) {
 	return config;
 }
@@ -66,9 +68,9 @@ function validateConfig(config, source) {
 function optionalAppList(value, kind, source) {
 	if (value == null) return [];
 	if (!Array.isArray(value)) throw new Error(`[config] ${source} 中 ${kind} 必须是数组`);
-	return value.map((item, index) => parseAppConfig(item, `${source} ${kind}[${index}]`));
+	return value.map((item, index) => parseAppConfig(item, kind, `${source} ${kind}[${index}]`));
 }
-function parseAppConfig(item, label) {
+function parseAppConfig(item, kind, label) {
 	if (!isPlainObject(item)) throw new Error(`[config] ${label} 必须是对象`);
 	if (typeof item.path !== "string" || item.path.trim() === "") throw new Error(`[config] ${label} 缺少 path`);
 	if (!isSafeName(item.name)) throw new Error(`[config] ${label} 缺少合法 name`);
@@ -81,8 +83,15 @@ function parseAppConfig(item, label) {
 		parsed.proxy = item.proxy;
 	}
 	if (item.buildEnv != null) parsed.buildEnv = parseEnvMap(item.buildEnv, `${label} buildEnv`);
-	if (item.env != null) parsed.env = parseEnvMap(item.env, `${label} env`);
-	return parsed;
+	if (kind === "web") return parsed;
+	const api = { ...parsed };
+	if (item.env != null) api.env = parseEnvMap(item.env, `${label} env`);
+	api.excludeOnIncremental = item.excludeOnIncremental != null ? parseExcludeOnIncremental(item.excludeOnIncremental, `${label} excludeOnIncremental`) : [...DEFAULT_EXCLUDE_ON_INCREMENTAL];
+	return api;
+}
+function parseExcludeOnIncremental(value, label) {
+	if (!Array.isArray(value) || value.some((entry) => typeof entry !== "string" || !isSafeName(entry))) throw new Error(`[config] ${label} 必须是字符串数组（目录/文件名，不含路径分隔符）`);
+	return value;
 }
 function parseEnvMap(value, label) {
 	if (!isPlainObject(value)) throw new Error(`[config] ${label} 必须是对象`);

package/dist/index.d.mts

@@ -2,6 +2,7 @@
 declare const CONFIG_FORMATS: readonly ["ts", "mts", "cts", "js", "mjs", "cjs", "json"];
 type ConfigFormat = (typeof CONFIG_FORMATS)[number];
 type ZpcEnvMap = Record<string, string | number | boolean>;
+/** api / web 应用配置公共字段 */
 interface ZpcAppConfig {
   /** 相对项目根的源码目录 */
   path: string;
@@ -11,14 +12,21 @@ interface ZpcAppConfig {
   proxy?: string;
   /** 仅构建期注入 */
   buildEnv?: ZpcEnvMap;
+}
+/** api 应用配置（额外含运行时 env 与增量部署排除项） */
+interface ZpcApiConfig extends ZpcAppConfig {
   /** 仅运行时注入（pm2） */
   env?: ZpcEnvMap;
+  /** 增量部署时排除、不覆盖的目录/文件名；默认 ["public"] */
+  excludeOnIncremental?: string[];
 }
+/** web 应用配置（静态站点，仅构建期 buildEnv，无运行时 env） */
+interface ZpcWebConfig extends ZpcAppConfig {}
 interface ZpcConfig {
   projectName: string;
-  api?: ZpcAppConfig[];
-  web?: ZpcAppConfig[];
+  api?: ZpcApiConfig[];
+  web?: ZpcWebConfig[];
 }
 declare function defineConfig(config: ZpcConfig): ZpcConfig;
 //#endregion
-export { type ConfigFormat, type ZpcAppConfig, type ZpcConfig, type ZpcEnvMap, defineConfig };
+export { type ConfigFormat, type ZpcApiConfig, type ZpcAppConfig, type ZpcConfig, type ZpcEnvMap, type ZpcWebConfig, defineConfig };

package/dist/index.mjs

@@ -1,2 +1,2 @@
-import { i as defineConfig } from "./config-BZc9pg7J.mjs";
+import { i as defineConfig } from "./config-DzcldbBT.mjs";
 export { defineConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhipu/zp-cli",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "内部单命令部署工具",
   "bin": {
     "zpc": "./dist/cli.mjs"

package/src/templates/zpc.config.schema.json

@@ -54,6 +54,15 @@
         "env": {
           "$ref": "#/definitions/envMap",
           "description": "仅运行时注入（pm2）"
+        },
+        "excludeOnIncremental": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "default": ["public"],
+          "description": "增量部署时排除、不覆盖的目录/文件名；仅 api 生效，默认 [\"public\"]"
         }
       }
     },