@zhipu/zp-cli 0.0.0 → 0.0.2

package/README.md

@@ -1,23 +1,129 @@
-# vite-plus-starter
+# zp-cli
 
-A starter for creating a Vite Plus project.
+内部单命令部署工具（`@zhipu/zp-cli`）。用 `zpc pack` 构建打包、`zpc deploy` 在服务器上解压并挂到 Nginx / PM2。
 
-## Development
+路线图见 [docs/ROADMAP.md](./docs/ROADMAP.md)。
 
-- Install dependencies:
+## 使用
 
 ```bash
-vp install
+# 在项目根生成 zpc.config
+zpc init
+
+# 构建并打出 <projectName>-dist.zip（依据 ~/.zpc 部署记录与部署目录自动判定全量/增量）
+zpc pack
+
+# 在服务器上：目录内需有 <projectName>-dist.zip + zpc.config.*（配置不要打进压缩包）
+zpc deploy
+zpc deploy --force      # 允许抢占冲突的 nginx proxy
 ```
 
-- Run the unit tests:
+可选环境变量：`DEPLOY_DIR`、`DEPLOY_FORCE`；`ZPC_HOME` 覆盖 `~/.zpc`（部署状态记录）；测试可用 `ZPC_API_ROOT` / `ZPC_WEB_ROOT` / `ZPC_NGINX_DEFAULT_D` / `ZPC_DEPLOY_SKIP_RUNTIME`。
+
+## 部署约定
+
+`zpc.config` 中的 `projectName` 即下文 `<system-tag>`。
+
+### 目录结构
+
+```text
+─┬─ etc/nginx/
+ │  ├─ default.d/
+ │  │  └─ <system-tag>.conf
+ │  └─ nginx.conf
+ └─ usr/share/nginx/
+    ├─ api/
+    │  └─ <system-tag>/
+    │     ├─ <api-1>/
+    │     │  ├─ dist
+    │     │  ├─ public
+    │     │  ├─ bootstrap.js
+    │     │  └─ package.json
+    │     ├─ <api-2>/
+    │     │  ├─ dist
+    │     │  ├─ public
+    │     │  ├─ bootstrap.js
+    │     │  └─ package.json
+    │     └─ ...
+    └─ html/
+       └─ <system-tag>/
+          ├─ <web-1>/
+          │  ├─ assets
+          │  └─ index.html
+          ├─ <web-2>/
+          │  ├─ assets
+          │  └─ index.html
+          └─ ...
+```
+
+### Nginx 配置
+
+1. 单系统配置放在 `/etc/nginx/default.d/`，文件名为 `<system-tag>.conf`（当前实现尚未完全对齐，见路线图「进行中」）：
+
+   ```text
+   location /<API_PROXY>/ {
+       proxy_pass http://127.0.0.1:<PORT>/;
+       proxy_http_version 1.1;
+       proxy_set_header Host $host;
+       proxy_set_header X-Real-IP $remote_addr;
+       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+       proxy_set_header X-Forwarded-Proto $scheme;
+       proxy_set_header Upgrade $http_upgrade;
+       proxy_set_header Connection "upgrade";
+   }
+
+   location = /<API_PROXY> {
+       return 301 /<API_PROXY>/;
+   }
+   ```
+
+2. 宿主机 `nginx.conf` 的 `server` 块须包含 `include`，以便加载系统配置（机器初始化时完成，非 `zpc deploy` 职责）：
+
+   ```text
+   server {
+       listen       80;
+       listen       [::]:80;
+       server_name  _;
+       root         /usr/share/nginx/html;
+
+       # Load configuration files for the default server block.
+       include /etc/nginx/default.d/*.conf;
+
+       error_page 404 /404.html;
+       location = /404.html {
+       }
+
+       error_page 500 502 503 504 /50x.html;
+       location = /50x.html {
+       }
+   }
+   ```
+
+服务器软件栈（Nginx、Node、pnpm、PM2 等）的一键安装不在本仓库范围，见路线图「展望」。
+
+## 开发
 
 ```bash
+# 安装依赖
+vp install
+# 校验（格式 / lint / 类型）
+vp check
+# 单元测试
 vp test
+# 构建可发布产物
+vp pack
+```
+
+## 发布
+
+因 pnpm 安全策略，access token 需配在用户级 npmrc（`~/.npmrc`）：
+
+```text
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}
 ```
 
-- Build the library:
+在环境变量中设置 `NPM_TOKEN` 后发布：
 
 ```bash
-vp pack
+pnpm publish
 ```

package/dist/build-dashboard-CqZVHPH7.mjs

@@ -0,0 +1,502 @@
+import { createBuildJobs, createBuildJobsContext, runBuildJobs, summarizeBuildFailures } from "./build-jobs-m5jbiNTx.mjs";
+import { spawn } from "node:child_process";
+import { platform } from "node:os";
+import { Box, Text, createApp, useApp, useInput, useLayoutSize } from "@vue-tui/runtime";
+import { Fragment, computed, createBlock, createElementBlock, createTextVNode, createVNode, defineComponent, nextTick, onScopeDispose, openBlock, ref, renderList, shallowRef, toDisplayString, unref, watch, withCtx } from "vue";
+import { ScrollBox } from "@vue-tui/components";
+import stripAnsi from "strip-ansi";
+//#region src/utils/clipboard.ts
+/** Windows clip.exe 从 stdin 读取 UTF-16LE；直接写 UTF-8 会在中文系统上乱码。 */
+function encodeWindowsClipboardInput(text) {
+	return Buffer.from(text, "utf16le");
+}
+function getClipboardCommand() {
+	switch (platform()) {
+		case "win32": return {
+			cmd: "clip",
+			args: []
+		};
+		case "darwin": return {
+			cmd: "pbcopy",
+			args: []
+		};
+		case "linux": return {
+			cmd: "xclip",
+			args: ["-selection", "clipboard"]
+		};
+		default: return null;
+	}
+}
+function writeClipboardStdin(text) {
+	if (platform() === "win32") return encodeWindowsClipboardInput(text);
+	return text;
+}
+function tryLinuxClipboard(text) {
+	const commands = [
+		{
+			cmd: "wl-copy",
+			args: []
+		},
+		{
+			cmd: "xclip",
+			args: ["-selection", "clipboard"]
+		},
+		{
+			cmd: "xsel",
+			args: ["--clipboard", "--input"]
+		}
+	];
+	return new Promise((resolve) => {
+		let index = 0;
+		function tryNext() {
+			if (index >= commands.length) {
+				resolve(false);
+				return;
+			}
+			const { cmd, args } = commands[index];
+			index += 1;
+			const proc = spawn(cmd, args, { stdio: [
+				"pipe",
+				"ignore",
+				"ignore"
+			] });
+			proc.on("error", () => tryNext());
+			proc.stdin.write(text, "utf8");
+			proc.stdin.end();
+			proc.on("close", (code) => {
+				if (code === 0) resolve(true);
+				else tryNext();
+			});
+		}
+		tryNext();
+	});
+}
+function copyWithCommand(text, cmd, args) {
+	return new Promise((resolve) => {
+		const proc = spawn(cmd, args, {
+			stdio: [
+				"pipe",
+				"ignore",
+				"ignore"
+			],
+			windowsHide: true
+		});
+		proc.on("error", () => resolve(false));
+		const input = writeClipboardStdin(text);
+		if (typeof input === "string") proc.stdin.write(input, "utf8");
+		else proc.stdin.write(input);
+		proc.stdin.end();
+		proc.on("close", (code) => resolve(code === 0));
+	});
+}
+function copyToClipboard(text) {
+	if (!text) return Promise.resolve(false);
+	const command = getClipboardCommand();
+	if (!command) return Promise.resolve(false);
+	if (platform() === "linux") return tryLinuxClipboard(text);
+	return copyWithCommand(text, command.cmd, command.args);
+}
+//#endregion
+//#region src/tui/pack/build-output.ts
+const ERROR_LINE_PATTERN = /\b(error|failed|failure|fatal|exception|err!|warn)\b|错误|失败|✗/i;
+function normalizeOutput(output) {
+	return stripAnsi(output).trimEnd();
+}
+function formatBuildInfo(job) {
+	return [
+		`[${job.label}]`,
+		`cwd: ${job.cwd}`,
+		`status: ${job.status}`,
+		`exit: ${job.exitCode ?? "-"}`,
+		"",
+		normalizeOutput(job.output)
+	].join("\n");
+}
+function extractErrorOutput(output) {
+	const trimmed = normalizeOutput(output);
+	if (!trimmed) return "";
+	const lines = trimmed.split("\n");
+	const matched = lines.filter((line) => ERROR_LINE_PATTERN.test(line));
+	if (matched.length > 0) return matched.join("\n");
+	return lines.slice(-40).join("\n").trim();
+}
+function formatErrorInfo(job) {
+	const body = extractErrorOutput(job.output);
+	if (!body) return `[${job.label}] 暂无错误输出`;
+	return [
+		`[${job.label}]`,
+		`exit: ${job.exitCode ?? "-"}`,
+		"",
+		body
+	].join("\n");
+}
+//#endregion
+//#region src/tui/pack/dashboard-input.ts
+function isFocusLog(event) {
+	if (event.type !== "key") return false;
+	return event.key.name === "tab" && !event.key.shift || event.key.name === "right";
+}
+function isFocusProjects(event) {
+	if (event.type !== "key") return false;
+	return event.key.name === "tab" && event.key.shift || event.key.name === "left";
+}
+function isLogPaneEscape(event) {
+	return event.type === "key" && event.key.name === "escape";
+}
+function isSingleKey(event, key) {
+	if (event.type === "text" && event.text === key) return true;
+	if (event.type !== "key") return false;
+	if (event.key.ctrl || event.key.meta || event.key.alt) return false;
+	const normalized = key.toLowerCase();
+	if (event.key.character === normalized) return true;
+	return event.key.name === normalized;
+}
+function isCopyBuildInfo(event) {
+	return isSingleKey(event, "y");
+}
+function isCopyErrorInfo(event) {
+	return isSingleKey(event, "e");
+}
+function isCancelDuringBuild(event) {
+	if (event.type === "text" && event.text === "q") return true;
+	if (event.type !== "key") return false;
+	if (event.key.name === "escape") return true;
+	if (event.key.character === "c" && event.key.ctrl) return true;
+	return event.key.character === "q" && !event.key.ctrl && !event.key.meta;
+}
+function isDismissAfterFailure(event) {
+	if (event.type === "text" && event.text === "q") return true;
+	if (event.type !== "key") return false;
+	return event.key.name === "escape" || event.key.name === "enter" || event.key.character === "q" && !event.key.ctrl && !event.key.meta;
+}
+//#endregion
+//#region src/tui/pack/use-build-dashboard.ts
+const statusIcon = {
+	waiting: "…",
+	running: "●",
+	success: "✓",
+	failed: "✗"
+};
+const COPY_HINT = " · y 复制日志 · e 复制错误";
+function useBuildDashboard(props) {
+	const selectedIndex = shallowRef(0);
+	const focusPane = shallowRef("projects");
+	const dismissed = shallowRef(false);
+	const copyNotice = shallowRef(null);
+	const logBox = ref(null);
+	const logFollowOutput = shallowRef(true);
+	const { exit } = useApp();
+	let copyNoticeTimer;
+	const doneCount = computed(() => props.jobs.filter((job) => job.status === "success" || job.status === "failed").length);
+	const failCount = computed(() => props.jobs.filter((job) => job.status === "failed").length);
+	const allDone = computed(() => doneCount.value === props.jobs.length);
+	const selectedJob = computed(() => props.jobs[selectedIndex.value]);
+	const footerText = computed(() => {
+		if (copyNotice.value) return copyNotice.value;
+		if (!allDone.value) {
+			if (focusPane.value === "log") return `构建中… ${doneCount.value}/${props.jobs.length} 完成 · ↑↓ 滚动日志 · ←/Shift+Tab 返回 · Ctrl+C/q 取消${COPY_HINT}`;
+			return `构建中… ${doneCount.value}/${props.jobs.length} 完成 · ↑↓ 切换项目 · Tab/→ 查看日志 · Ctrl+C/q 取消${COPY_HINT}`;
+		}
+		if (failCount.value > 0) return `${failCount.value} 个失败 · 按 q / Enter / Esc 退出${COPY_HINT}`;
+		if (props.stayOnSuccess) return `全部构建成功 · 按 q / Enter / Esc 退出${COPY_HINT}`;
+		return "全部构建成功";
+	});
+	function showCopyNotice(message) {
+		copyNotice.value = message;
+		clearTimeout(copyNoticeTimer);
+		copyNoticeTimer = setTimeout(() => {
+			copyNotice.value = null;
+		}, 2e3);
+	}
+	async function copyCurrentBuildInfo() {
+		const job = selectedJob.value;
+		if (!job) return;
+		showCopyNotice(await copyToClipboard(formatBuildInfo(job)) ? `已复制 ${job.label} 构建日志` : "复制失败，请检查系统剪贴板工具");
+	}
+	async function copyCurrentErrorInfo() {
+		const job = selectedJob.value;
+		if (!job) return;
+		showCopyNotice(await copyToClipboard(formatErrorInfo(job)) ? `已复制 ${job.label} 错误信息` : "复制失败，请检查系统剪贴板工具");
+	}
+	function selectJob(index) {
+		selectedIndex.value = index;
+		logFollowOutput.value = true;
+		logBox.value?.scrollToBottom();
+	}
+	function requestExit() {
+		if (dismissed.value) return;
+		dismissed.value = true;
+		exit();
+	}
+	onScopeDispose(() => {
+		clearTimeout(copyNoticeTimer);
+	});
+	watch(allDone, (done) => {
+		if (!done || failCount.value > 0 || props.stayOnSuccess) return;
+		requestExit();
+	}, { immediate: true });
+	useInput((event) => {
+		if (dismissed.value) return;
+		if (isCopyBuildInfo(event)) {
+			copyCurrentBuildInfo();
+			return;
+		}
+		if (isCopyErrorInfo(event)) {
+			copyCurrentErrorInfo();
+			return;
+		}
+		if (isFocusLog(event)) {
+			focusPane.value = "log";
+			return;
+		}
+		if (isFocusProjects(event)) {
+			focusPane.value = "projects";
+			return;
+		}
+		if (!allDone.value && focusPane.value === "log" && isLogPaneEscape(event)) {
+			focusPane.value = "projects";
+			return;
+		}
+		if (event.type === "key") if (focusPane.value === "projects") {
+			if (event.key.name === "up") {
+				selectJob(Math.max(0, selectedIndex.value - 1));
+				return;
+			}
+			if (event.key.name === "down") {
+				selectJob(Math.min(props.jobs.length - 1, selectedIndex.value + 1));
+				return;
+			}
+		} else {
+			const handle = logBox.value;
+			if (!handle) return;
+			if (event.key.name === "up") {
+				if (handle.scrollByLines(-1)) logFollowOutput.value = false;
+				return;
+			}
+			if (event.key.name === "down") {
+				handle.scrollByLines(1);
+				return;
+			}
+			if (event.key.name === "page-up") {
+				if (handle.scrollByLines(-10)) logFollowOutput.value = false;
+				return;
+			}
+			if (event.key.name === "page-down") {
+				handle.scrollByLines(10);
+				return;
+			}
+		}
+		if (!allDone.value) {
+			if (!isCancelDuringBuild(event)) return;
+			props.onCancel?.();
+			requestExit();
+			return;
+		}
+		if (failCount.value === 0) {
+			if (!props.stayOnSuccess || !allDone.value) return;
+			if (!isDismissAfterFailure(event)) return;
+			requestExit();
+			return;
+		}
+		if (!isDismissAfterFailure(event)) return;
+		requestExit();
+	});
+	watch(() => selectedJob.value?.output, () => {
+		if (selectedJob.value?.status !== "running" || !logFollowOutput.value) return;
+		nextTick(() => {
+			logBox.value?.scrollToBottom();
+		});
+	});
+	return {
+		statusIcon,
+		selectedIndex,
+		focusPane,
+		doneCount,
+		failCount,
+		allDone,
+		selectedJob,
+		footerText,
+		logBox
+	};
+}
+//#endregion
+//#region src/tui/pack/BuildDashboard.vue
+const _sfc_main = /*@__PURE__*/ defineComponent({
+	__name: "BuildDashboard",
+	props: {
+		jobs: {},
+		onCancel: { type: Function },
+		stayOnSuccess: { type: Boolean }
+	},
+	setup(__props) {
+		const props = __props;
+		const { width, height } = useLayoutSize();
+		const { statusIcon, selectedIndex, focusPane, doneCount, failCount, allDone, selectedJob, footerText, logBox } = useBuildDashboard(props);
+		return (_ctx, _cache) => {
+			return openBlock(), createBlock(unref(Box), {
+				flexDirection: "column",
+				width: unref(width),
+				height: unref(height),
+				minHeight: 0
+			}, {
+				default: withCtx(() => [
+					createVNode(unref(Box), {
+						paddingY: 0,
+						paddingX: 1,
+						flexShrink: 0
+					}, {
+						default: withCtx(() => [
+							createVNode(unref(Text), { bold: "" }, {
+								default: withCtx(() => [..._cache[0] || (_cache[0] = [createTextVNode("zpc pack", -1)])]),
+								_: 1
+							}),
+							createVNode(unref(Text), { dimColor: "" }, {
+								default: withCtx(() => [..._cache[1] || (_cache[1] = [createTextVNode(" · 并行构建 · ", -1)])]),
+								_: 1
+							}),
+							createVNode(unref(Text), null, {
+								default: withCtx(() => [createTextVNode(toDisplayString(unref(doneCount)) + "/" + toDisplayString(__props.jobs.length) + " 完成", 1)]),
+								_: 1
+							})
+						]),
+						_: 1
+					}),
+					createVNode(unref(Box), {
+						flexDirection: "row",
+						flexGrow: 1,
+						minHeight: 0,
+						width: "100%",
+						overflow: "hidden",
+						marginTop: 1
+					}, {
+						default: withCtx(() => [createVNode(unref(Box), {
+							width: 28,
+							flexDirection: "column",
+							borderStyle: "single",
+							borderColor: unref(focusPane) === "projects" ? "cyan" : void 0,
+							borderDimColor: unref(focusPane) !== "projects",
+							paddingX: 1,
+							paddingY: 0,
+							marginRight: 1,
+							flexShrink: 0,
+							minHeight: 0,
+							overflow: "hidden"
+						}, {
+							default: withCtx(() => [createVNode(unref(Text), {
+								bold: "",
+								dimColor: unref(focusPane) !== "projects"
+							}, {
+								default: withCtx(() => [..._cache[2] || (_cache[2] = [createTextVNode("项目", -1)])]),
+								_: 1
+							}, 8, ["dimColor"]), createVNode(unref(Box), {
+								flexDirection: "column",
+								marginTop: 1,
+								minHeight: 0,
+								overflow: "hidden"
+							}, {
+								default: withCtx(() => [(openBlock(true), createElementBlock(Fragment, null, renderList(__props.jobs, (job, index) => {
+									return openBlock(), createBlock(unref(Box), { key: job.id }, {
+										default: withCtx(() => [createVNode(unref(Text), {
+											color: index === unref(selectedIndex) ? "cyan" : job.status === "waiting" ? "gray" : void 0,
+											bold: index === unref(selectedIndex),
+											dimColor: job.status === "waiting" && index !== unref(selectedIndex)
+										}, {
+											default: withCtx(() => [createTextVNode(toDisplayString(unref(statusIcon)[job.status]) + " " + toDisplayString(job.label), 1)]),
+											_: 2
+										}, 1032, [
+											"color",
+											"bold",
+											"dimColor"
+										])]),
+										_: 2
+									}, 1024);
+								}), 128))]),
+								_: 1
+							})]),
+							_: 1
+						}, 8, ["borderColor", "borderDimColor"]), createVNode(unref(Box), {
+							flexDirection: "column",
+							flexGrow: 1,
+							minHeight: 0,
+							width: "100%",
+							overflow: "hidden",
+							borderStyle: "single",
+							borderColor: unref(focusPane) === "log" ? "cyan" : void 0,
+							borderDimColor: unref(focusPane) !== "log",
+							paddingX: 1,
+							paddingY: 0
+						}, {
+							default: withCtx(() => [createVNode(unref(Box), { flexShrink: 0 }, {
+								default: withCtx(() => [createVNode(unref(Text), {
+									bold: "",
+									dimColor: unref(focusPane) !== "log"
+								}, {
+									default: withCtx(() => [createTextVNode(toDisplayString(unref(selectedJob)?.label ?? ""), 1)]),
+									_: 1
+								}, 8, ["dimColor"])]),
+								_: 1
+							}), createVNode(unref(Box), {
+								flexGrow: 1,
+								minHeight: 0,
+								width: "100%",
+								overflow: "hidden",
+								marginTop: 1
+							}, {
+								default: withCtx(() => [createVNode(unref(ScrollBox), {
+									ref_key: "logBox",
+									ref: logBox
+								}, {
+									default: withCtx(() => [createVNode(unref(Text), { wrap: "wrap" }, {
+										default: withCtx(() => [createTextVNode(toDisplayString(unref(selectedJob)?.status === "waiting" ? "（等待中…）" : unref(selectedJob)?.output || "（无输出）"), 1)]),
+										_: 1
+									})]),
+									_: 1
+								}, 512)]),
+								_: 1
+							})]),
+							_: 1
+						}, 8, ["borderColor", "borderDimColor"])]),
+						_: 1
+					}),
+					createVNode(unref(Box), {
+						paddingY: 0,
+						paddingX: 1,
+						marginTop: 1,
+						flexShrink: 0
+					}, {
+						default: withCtx(() => [createVNode(unref(Text), { color: unref(failCount) > 0 && unref(allDone) ? "red" : "gray" }, {
+							default: withCtx(() => [createTextVNode(toDisplayString(unref(footerText)), 1)]),
+							_: 1
+						}, 8, ["color"])]),
+						_: 1
+					})
+				]),
+				_: 1
+			}, 8, ["width", "height"]);
+		};
+	}
+});
+//#endregion
+//#region src/tui/pack/build-dashboard.ts
+async function runBuildDashboard(specs, options = {}) {
+	const jobs = createBuildJobs(specs);
+	const ctx = createBuildJobsContext();
+	const app = createApp(_sfc_main, {
+		jobs,
+		onCancel: () => ctx.abort(),
+		stayOnSuccess: options.stayOnSuccess
+	});
+	app.mount({
+		mode: "fullscreen",
+		patchConsole: false,
+		exitOnCtrlC: false
+	});
+	const builds = runBuildJobs(jobs, ctx, options);
+	await app.waitUntilExit();
+	await builds;
+	if (ctx.isAborted()) throw new Error("[pack] 构建已取消");
+	const failure = summarizeBuildFailures(jobs);
+	if (failure) throw new Error(failure);
+}
+//#endregion
+export { runBuildDashboard };