create-ssnode-cli 0.2.5 → 0.2.7

package/templates/web/scripts/publish.cjs

@@ -1,57 +1,79 @@
 /**
  * description 一键部署脚本
- * v1.6版本
+ * v1.7版本
  * 执行命令：npm run publish
  * 沙盒命令：npm run publishs
  * v1.5: 自动递增版本号 + 输出构建包大小
  * v1.6: 支持秘钥登录（privateKeyPath / passphrase）
+ * v1.7: 交互化——多服务器目标菜单选择(key(host))、版本号策略选择(自增默认/维持/自定义)；
+ *       部署后归档 <dist>_releases/v<版本>_<时间戳>.tar.gz(rollback 列版本回退用)，按 keepVersions 轮转
  */
-const shelljs = require('shelljs');
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
-const { NodeSSH } = require('node-ssh');
-const serverConfig = require('./server.config.json');
+const shelljs = require("shelljs");
+const fs = require("fs");
+const path = require("path");
+const os = require("os");
+const { NodeSSH } = require("node-ssh");
+const {
+	selectEnvKey,
+	selectVersion,
+	closeInteractive,
+} = require("./lib/interactive.cjs");
+const serverConfig = require("./server.config.json");
 
 class DynamicOutput {
-  constructor() {
-    this.lastMessage = '';
-    this.progressEnabled = process.stdout.isTTY;
-  }
-
-  update(message) {
-    if (this.progressEnabled) {
-      process.stdout.write('\r' + ' '.repeat(this.lastMessage.length));
-      process.stdout.write('\r' + message);
-      this.lastMessage = message;
-    } else {
-      shelljs.echo(message);
-    }
-  }
-
-  final(message) {
-    if (this.progressEnabled) {
-      process.stdout.write('\r' + message + '\n');
-    } else {
-      shelljs.echo(message);
-    }
-    this.lastMessage = '';
-  }
+	constructor() {
+		this.lastMessage = "";
+		this.progressEnabled = process.stdout.isTTY;
+	}
+
+	update(message) {
+		if (this.progressEnabled) {
+			process.stdout.write("\r" + " ".repeat(this.lastMessage.length));
+			process.stdout.write("\r" + message);
+			this.lastMessage = message;
+		} else {
+			shelljs.echo(message);
+		}
+	}
+
+	final(message) {
+		if (this.progressEnabled) {
+			process.stdout.write("\r" + message + "\n");
+		} else {
+			shelljs.echo(message);
+		}
+		this.lastMessage = "";
+	}
 }
 
 const output = new DynamicOutput();
 const SSH_STATUS = {
-  CONNECTING: '正在连接服务器...',
-  UPLOADING: '正在上传文件...',
-  DEPLOYING: '正在部署...'
+	CONNECTING: "正在连接服务器...",
+	UPLOADING: "正在上传文件...",
+	DEPLOYING: "正在部署...",
 };
 
-// 初始化配置
-const findEnvIndex = process.argv.indexOf('--env');
-let enviromentConfig = serverConfig.deploy;
+// 初始化配置(--env <key> 显式选目标;未传时 TTY 下交互选,非 TTY(CI)静默用 deploy 保持旧行为。
+// key 拼错/不存在时 fail-fast,静默回落 deploy 会发错机器)
+const findEnvIndex = process.argv.indexOf("--env");
+let enviromentConfig;
 if (findEnvIndex !== -1) {
-  const configKey = process.argv[findEnvIndex + 1];
-  enviromentConfig = serverConfig[configKey] || serverConfig.deploy;
+	const configKey = process.argv[findEnvIndex + 1];
+	if (!configKey) {
+		shelljs.echo(
+			"❌ --env 缺少值: --env <目标名>(server.config.json 里的 key)",
+		);
+		process.exit(1);
+	}
+	if (!serverConfig[configKey]) {
+		shelljs.echo(
+			`❌ --env ${configKey} 在 server.config.json 中不存在(可用: ${Object.keys(
+				serverConfig,
+			).join(", ")})`,
+		);
+		process.exit(1);
+	}
+	enviromentConfig = serverConfig[configKey];
 }
 
 const ssh = new NodeSSH();
@@ -59,181 +81,258 @@ const startTime = Date.now();
 
 // 构造 SSH 连接配置：按 authMode 决定认证方式，秘钥优先级仍可被命令行 --key 临时覆盖
 function buildSSHConfig(config) {
-  const baseConfig = {
-    host: config.host,
-    port: config.port,
-    username: config.username,
-    readyTimeout: 120_000
-  };
-
-  // 命令行参数 --key 临时指定秘钥路径，优先级最高，无论 authMode 如何都走秘钥登录
-  const keyIndex = process.argv.indexOf('--key');
-  const usePrivateKey = keyIndex !== -1 || config.authMode === 'privateKey';
-  if (!usePrivateKey) {
-    if (!config.password) {
-      throw new Error('未配置登录凭证：请在 server.config.json 中配置 authMode=password + password，或 authMode=privateKey + privateKey');
-    }
-    return { ...baseConfig, password: config.password };
-  }
-
-  // 秘钥登录：优先取命令行 --key，否则取配置 privateKey.privateKeyPath
-  const privateKeyPath =
-    keyIndex !== -1 ? process.argv[keyIndex + 1] : config.privateKey?.privateKeyPath;
-
-  if (!privateKeyPath) {
-    throw new Error('秘钥登录缺少 privateKeyPath：请在 server.config.json 的 privateKey.privateKeyPath 中配置，或通过命令行 --key 传入');
-  }
-
-  // 支持 ~ 开头的家目录路径
-  const resolvedKeyPath = privateKeyPath.replace(/^~(?=$|\/|\\)/, os.homedir());
-  if (!fs.existsSync(resolvedKeyPath)) {
-    throw new Error(`秘钥文件不存在: ${resolvedKeyPath}`);
-  }
-
-  const sshConfig = {
-    ...baseConfig,
-    // node-ssh@13 要求 privateKey 为字符串(Buffer 会被断言拦截)
-    privateKey: fs.readFileSync(resolvedKeyPath, 'utf8')
-  };
-  if (config.privateKey?.passphrase) {
-    sshConfig.passphrase = config.privateKey.passphrase;
-  }
-  return sshConfig;
+	const baseConfig = {
+		host: config.host,
+		port: config.port,
+		username: config.username,
+		readyTimeout: 120_000,
+	};
+
+	// 命令行参数 --key 临时指定秘钥路径，优先级最高，无论 authMode 如何都走秘钥登录
+	const keyIndex = process.argv.indexOf("--key");
+	const usePrivateKey = keyIndex !== -1 || config.authMode === "privateKey";
+	if (!usePrivateKey) {
+		if (!config.password) {
+			throw new Error(
+				"未配置登录凭证：请在 server.config.json 中配置 authMode=password + password，或 authMode=privateKey + privateKey",
+			);
+		}
+		return { ...baseConfig, password: config.password };
+	}
+
+	// 秘钥登录：优先取命令行 --key，否则取配置 privateKey.privateKeyPath
+	const privateKeyPath =
+		keyIndex !== -1
+			? process.argv[keyIndex + 1]
+			: config.privateKey?.privateKeyPath;
+
+	if (!privateKeyPath) {
+		throw new Error(
+			"秘钥登录缺少 privateKeyPath：请在 server.config.json 的 privateKey.privateKeyPath 中配置，或通过命令行 --key 传入",
+		);
+	}
+
+	// 支持 ~ 开头的家目录路径
+	const resolvedKeyPath = privateKeyPath.replace(/^~(?=$|\/|\\)/, os.homedir());
+	if (!fs.existsSync(resolvedKeyPath)) {
+		throw new Error(`秘钥文件不存在: ${resolvedKeyPath}`);
+	}
+
+	const sshConfig = {
+		...baseConfig,
+		// node-ssh@13 要求 privateKey 为字符串(Buffer 会被断言拦截)
+		privateKey: fs.readFileSync(resolvedKeyPath, "utf8"),
+	};
+	if (config.privateKey?.passphrase) {
+		sshConfig.passphrase = config.privateKey.passphrase;
+	}
+	return sshConfig;
 }
 
-const exec = (command = '') =>
-  new Promise((resolve, reject) => {
-    shelljs.exec(command, { silent: true }, (code, stdout, stderr) => {
-      code === 0 ? resolve(stdout) : reject(new Error(stderr || `Command failed: ${command}`));
-    });
-  });
+const exec = (command = "") =>
+	new Promise((resolve, reject) => {
+		shelljs.exec(command, { silent: true }, (code, stdout, stderr) => {
+			code === 0
+				? resolve(stdout)
+				: reject(new Error(stderr || `Command failed: ${command}`));
+		});
+	});
+
+function getPackageJsonPath() {
+	return path.join(shelljs.pwd().toString(), "package.json");
+}
+
+function readVersion() {
+	return JSON.parse(fs.readFileSync(getPackageJsonPath(), "utf-8")).version;
+}
+
+function writeVersion(version) {
+	const packageJson = JSON.parse(
+		fs.readFileSync(getPackageJsonPath(), "utf-8"),
+	);
+	packageJson.version = version;
+	fs.writeFileSync(
+		getPackageJsonPath(),
+		JSON.stringify(packageJson, null, 2) + "\n",
+	);
+}
+
+function bumpSemver(version) {
+	const versionParts = version.split(".");
+	versionParts[versionParts.length - 1] =
+		Number(versionParts[versionParts.length - 1]) + 1;
+	return versionParts.join(".");
+}
 
+// 非交互(CI)默认行为:读当前版本、自增、写回
 function bumpVersion() {
-  const packageJsonPath = path.join(shelljs.pwd().toString(), 'package.json');
-  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
-  const versionParts = packageJson.version.split('.');
-  versionParts[versionParts.length - 1] = Number(versionParts[versionParts.length - 1]) + 1;
-  packageJson.version = versionParts.join('.');
-  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
-  return packageJson.version;
+	const next = bumpSemver(readVersion());
+	writeVersion(next);
+	return next;
 }
 
 function getDirSize(dirPath) {
-  let totalSize = 0;
-  const files = shelljs.find(dirPath).filter((f) => shelljs.test('-f', f));
-  files.forEach((f) => {
-    totalSize += fs.statSync(f).size;
-  });
-  return totalSize;
+	let totalSize = 0;
+	const files = shelljs.find(dirPath).filter((f) => shelljs.test("-f", f));
+	files.forEach((f) => {
+		totalSize += fs.statSync(f).size;
+	});
+	return totalSize;
 }
 
 function formatSize(bytes) {
-  if (bytes < 1024) return `${bytes} B`;
-  if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
-  return `${(bytes / 1024 / 1024).toFixed(2)} MB`;
+	if (bytes < 1024) return `${bytes} B`;
+	if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
+	return `${(bytes / 1024 / 1024).toFixed(2)} MB`;
 }
 
 async function main() {
-  try {
-    const newVersion = bumpVersion();
-    output.final(`📌 版本号已更新: ${newVersion}`);
-
-    output.update('🚀 正在打包项目...');
-    await exec('npm run build');
-
-    const distPath = path.join(shelljs.pwd().toString(), enviromentConfig.serverWebDist || 'dist');
-    const distSize = getDirSize(distPath);
-    output.final(`📦 构建产物大小: ${formatSize(distSize)}`);
-
-    output.update('🗜️ 正在压缩构建文件...');
-    const { splitIncludes, splitUpload, serverWebDist } = enviromentConfig;
-    if (serverWebDist !== 'dist') {
-      await exec(`mv dist/ ${serverWebDist}/`);
-    }
-    const splitUploadFileNames = [];
-
-    if (splitIncludes?.length) {
-      await Promise.all(
-        splitIncludes.map(async (e) => {
-          if (splitUpload) {
-            const targetTar = `${serverWebDist}.${e}.tar.gz`;
-            await exec(`COPYFILE_DISABLE=1 tar zcvf ${targetTar} ${serverWebDist}/${e}`);
-            splitUploadFileNames.push(targetTar);
-          }
-          await exec(`rm -rf ${serverWebDist}/${e}`);
-        })
-      );
-    }
-
-    const targetTar = `${serverWebDist}.tar.gz`;
-    await exec(`COPYFILE_DISABLE=1 tar zcvf ${targetTar} ${serverWebDist}/`);
-    splitUploadFileNames.unshift(targetTar);
-
-    output.update(SSH_STATUS.CONNECTING);
-    await ssh.connect(buildSSHConfig(enviromentConfig));
-
-    output.update(SSH_STATUS.UPLOADING);
-    await ssh.mkdir(enviromentConfig.serverWebPath);
-
-    const sftp = await ssh.requestSFTP();
-    const totalFiles = splitUploadFileNames.length;
-
-    await Promise.all(
-      splitUploadFileNames.map(async (file, index) => {
-        const localPath = path.join(shelljs.pwd().toString(), file);
-        const remotePath = `${enviromentConfig.serverWebPath}/${file}`;
-
-        await ssh.putFile(localPath, remotePath, sftp, {
-          concurrency: 10,
-          step: (transferred, _, total) => {
-            const progress = ((transferred / total) * 100).toFixed(1);
-            output.update(
-              `${SSH_STATUS.UPLOADING} (${index + 1}/${totalFiles}) ${progress}% ${file}`
-            );
-          }
-        });
-      })
-    );
-
-    output.update(SSH_STATUS.DEPLOYING);
-    const commands = [
-      `rm -rf ${serverWebDist}_last_bak.tar.gz`,
-      `tar zcvf ${serverWebDist}_last_bak.tar.gz ${serverWebDist}_bak/`,
-      `rm -rf ${serverWebDist}_bak/`,
-      `mv ${serverWebDist}/ ${serverWebDist}_bak/`,
-      ...splitUploadFileNames.map((e) => `tar zxvf ${e} && rm -rf ${e}`),
-      ...(!splitUpload
-        ? splitIncludes.map((e) => `cp -r ${serverWebDist}_bak/${e} ${serverWebDist}`)
-        : [])
-    ];
-
-    for (const cmd of commands) {
-      await ssh.execCommand(cmd, { cwd: enviromentConfig.serverWebPath });
-    }
-
-    splitUploadFileNames.forEach((f) => shelljs.rm(f));
-    if (serverWebDist !== 'dist') {
-      await exec(`mv ${serverWebDist}/ dist/`);
-    }
-    const duration = ((Date.now() - startTime) / 1000).toFixed(1);
-    const now = new Date();
-    const timeStr = now.toLocaleString('zh-CN', {
-      year: 'numeric',
-      month: '2-digit',
-      day: '2-digit',
-      hour: '2-digit',
-      minute: '2-digit',
-      second: '2-digit'
-    });
-    output.final(
-      `✅ 部署成功！ ${timeStr} 用时：${duration}s\n✅ 访问地址：${enviromentConfig.preview}`
-    );
-  } catch (error) {
-    output.final(`❌ 部署失败: ${error.message}`);
-    process.exit(1);
-  } finally {
-    ssh.dispose();
-  }
+	try {
+		// 未显式 --env:TTY 交互选目标(菜单 `key(host)`),非 TTY 静默回落 deploy(CI 兼容)
+		if (!enviromentConfig) {
+			const envKey = process.stdin.isTTY
+				? await selectEnvKey(serverConfig)
+				: Object.keys(serverConfig).length === 1
+				? Object.keys(serverConfig)[0]
+				: "deploy";
+			enviromentConfig = serverConfig[envKey];
+			output.final(`🎯 部署目标: ${envKey}(${enviromentConfig.host})`);
+		}
+
+		// 版本策略:TTY 交互选(自增默认/维持当前/自定义);非 TTY 保持旧行为自动自增
+		let newVersion;
+		if (process.stdin.isTTY) {
+			const currentVersion = readVersion();
+			newVersion = await selectVersion(
+				currentVersion,
+				bumpSemver(currentVersion),
+			);
+			if (newVersion !== currentVersion) {
+				writeVersion(newVersion);
+				output.final(`📌 版本号已更新: ${newVersion}`);
+			} else {
+				output.final(`📌 维持当前版本: ${newVersion}`);
+			}
+		} else {
+			newVersion = bumpVersion();
+			output.final(`📌 版本号已更新: ${newVersion}`);
+		}
+
+		output.update("🚀 正在打包项目...");
+		await exec("npm run build");
+
+		const distPath = path.join(
+			shelljs.pwd().toString(),
+			enviromentConfig.serverWebDist || "dist",
+		);
+		const distSize = getDirSize(distPath);
+		output.final(`📦 构建产物大小: ${formatSize(distSize)}`);
+
+		output.update("🗜️ 正在压缩构建文件...");
+		const { splitIncludes, splitUpload, serverWebDist } = enviromentConfig;
+		if (serverWebDist !== "dist") {
+			await exec(`mv dist/ ${serverWebDist}/`);
+		}
+		const splitUploadFileNames = [];
+
+		if (splitIncludes?.length) {
+			await Promise.all(
+				splitIncludes.map(async (e) => {
+					if (splitUpload) {
+						const targetTar = `${serverWebDist}.${e}.tar.gz`;
+						await exec(
+							`COPYFILE_DISABLE=1 tar zcvf ${targetTar} ${serverWebDist}/${e}`,
+						);
+						splitUploadFileNames.push(targetTar);
+					}
+					await exec(`rm -rf ${serverWebDist}/${e}`);
+				}),
+			);
+		}
+
+		const targetTar = `${serverWebDist}.tar.gz`;
+		await exec(`COPYFILE_DISABLE=1 tar zcvf ${targetTar} ${serverWebDist}/`);
+		splitUploadFileNames.unshift(targetTar);
+
+		output.update(SSH_STATUS.CONNECTING);
+		await ssh.connect(buildSSHConfig(enviromentConfig));
+
+		output.update(SSH_STATUS.UPLOADING);
+		await ssh.mkdir(enviromentConfig.serverWebPath);
+
+		const sftp = await ssh.requestSFTP();
+		const totalFiles = splitUploadFileNames.length;
+
+		await Promise.all(
+			splitUploadFileNames.map(async (file, index) => {
+				const localPath = path.join(shelljs.pwd().toString(), file);
+				const remotePath = `${enviromentConfig.serverWebPath}/${file}`;
+
+				await ssh.putFile(localPath, remotePath, sftp, {
+					concurrency: 10,
+					step: (transferred, _, total) => {
+						const progress = ((transferred / total) * 100).toFixed(1);
+						output.update(
+							`${SSH_STATUS.UPLOADING} (${
+								index + 1
+							}/${totalFiles}) ${progress}% ${file}`,
+						);
+					},
+				});
+			}),
+		);
+
+		output.update(SSH_STATUS.DEPLOYING);
+		// keepVersions:<dist>_releases 保留的版本归档数,默认 3(rollback 交互列版本回退用)
+		const keepVersions = enviromentConfig.keepVersions || 1;
+
+		const commands = [
+			`rm -rf ${serverWebDist}_last_bak.tar.gz`,
+			`tar zcvf ${serverWebDist}_last_bak.tar.gz ${serverWebDist}_bak/`,
+			`rm -rf ${serverWebDist}_bak/`,
+			`mv ${serverWebDist}/ ${serverWebDist}_bak/`,
+			...splitUploadFileNames.map((e) => `tar zxvf ${e} && rm -rf ${e}`),
+			...(!splitUpload
+				? splitIncludes.map(
+						(e) => `cp -r ${serverWebDist}_bak/${e} ${serverWebDist}`,
+				  )
+				: []),
+			// 部署完成后归档本次发布(完整 dist,dist_bak 链之外的多版本历史),再按 keepVersions 轮转清理旧归档
+			`mkdir -p ${serverWebDist}_releases`,
+			`ts=$(date +%Y%m%d%H%M%S) && tar zcf ${serverWebDist}_releases/v${newVersion}_\${ts}.tar.gz ${serverWebDist}/`,
+			`ls -t ${serverWebDist}_releases/*.tar.gz | tail -n +${
+				keepVersions + 1
+			} | xargs rm -f`,
+		];
+
+		for (const cmd of commands) {
+			await ssh.execCommand(cmd, { cwd: enviromentConfig.serverWebPath });
+		}
+
+		splitUploadFileNames.forEach((f) => shelljs.rm(f));
+		if (serverWebDist !== "dist") {
+			await exec(`mv ${serverWebDist}/ dist/`);
+		}
+		const duration = ((Date.now() - startTime) / 1000).toFixed(1);
+		const now = new Date();
+		const timeStr = now.toLocaleString("zh-CN", {
+			year: "numeric",
+			month: "2-digit",
+			day: "2-digit",
+			hour: "2-digit",
+			minute: "2-digit",
+			second: "2-digit",
+		});
+		output.final(
+			`✅ 部署成功！ ${timeStr} 用时：${duration}s\n✅ 访问地址：${enviromentConfig.preview}`,
+		);
+	} catch (error) {
+		output.final(`❌ 部署失败: ${error.message}`);
+		process.exit(1);
+	} finally {
+		closeInteractive(); // 释放 readline 的 stdin 句柄,进程才能自然退出
+		ssh.dispose();
+	}
 }
 
 main();