ylyx-cli 1.0.2 → 1.0.4

package/bin/ylyx.js

@@ -5,6 +5,7 @@ const { generate } = require('../lib/index');
 const { listTemplates, getTemplateInfo, addTemplate } = require('../lib/template');
 const { interactiveCreate } = require('../lib/interactive');
 const { setMode, initConfig } = require('../lib/config');
+const { deploy } = require('../lib/deploy');
 const pkg = require('../package.json');
 
 program.name('ylyx').description('公司内部代码生成模板脚手架工具').version(pkg.version);
@@ -110,6 +111,33 @@ program
 		addTemplate(templateName, templatePath);
 	});
 
+program
+	.command('deploy')
+	.description('部署：递归上传本地目录到远端目录（读取当前项目 .ylyxrc.json 的 deploy 字段）')
+	.option('--env <env>', '部署环境：test|prod（不传会提示选择）')
+	.option('--host <host>', '覆盖 deploy.host')
+	.option('--port <port>', '覆盖 deploy.port')
+	.option('-u, --username <username>', '覆盖 deploy.username')
+	.option('-p, --password <password>', '覆盖 deploy.password')
+	.option('--local <path>', '覆盖 deploy.localDir（默认 ./EXTERNAL_DIGIC）')
+	.option('--remote <path>', '覆盖 deploy.remoteDir')
+	.action(async (options) => {
+		try {
+			await deploy({
+				env: options.env,
+				host: options.host,
+				port: options.port,
+				username: options.username,
+				password: options.password,
+				localDir: options.local,
+				remoteDir: options.remote,
+			});
+		} catch (error) {
+			console.error('❌ 部署失败:', error.message);
+			process.exit(1);
+		}
+	});
+
 program
 	.command('install <repo-url>')
 	.alias('i')

package/lib/deploy.js

@@ -0,0 +1,229 @@
+const path = require('path');
+const fs = require('fs');
+const crypto = require('crypto');
+const ora = require('ora');
+const prompts = require('prompts');
+const archiver = require('archiver');
+const { readProjectConfig } = require('./utils');
+
+let spinner = null; // 加载实例
+
+function pad2(n) {
+  return String(n).padStart(2, '0');
+}
+
+function formatTimestampForFolderName(date = new Date()) {
+  // 用户要求：YYYY-MM-DD HH:mm:ss（注意：该字符串用于 zip 内的顶层目录名，不受 Windows 文件名限制）
+  const yyyy = date.getFullYear();
+  const MM = pad2(date.getMonth() + 1);
+  const dd = pad2(date.getDate());
+  const HH = pad2(date.getHours());
+  const mm = pad2(date.getMinutes());
+  const ss = pad2(date.getSeconds());
+  return `${yyyy}-${MM}-${dd} ${HH}:${mm}:${ss}`;
+}
+
+function sanitizeFileName(name) {
+  // Windows 文件名不允许 : * ? " < > | 等，这里做最小化替换，用于 zip 文件名
+  return String(name)
+    .replace(/[\\/:*?"<>|]/g, '-')
+    .replace(/\s+/g, '_')
+    .slice(0, 180);
+}
+
+function listFilesRecursively(rootDir) {
+  const out = [];
+  const stack = [rootDir];
+  while (stack.length) {
+    const current = stack.pop();
+    const entries = fs.readdirSync(current);
+    for (const e of entries) {
+      const p = path.join(current, e);
+      const st = fs.statSync(p);
+      if (st.isDirectory()) stack.push(p);
+      else if (st.isFile()) out.push({ path: p, size: st.size, mtimeMs: st.mtimeMs });
+    }
+  }
+  // 稳定排序
+  out.sort((a, b) => a.path.localeCompare(b.path));
+  return out;
+}
+
+function computeDirHashShort(dir) {
+  const h = crypto.createHash('sha256');
+  const files = listFilesRecursively(dir);
+  for (const f of files) {
+    const rel = path.relative(dir, f.path).replace(/\\/g, '/');
+    h.update(rel);
+    h.update('\n');
+    h.update(String(f.size));
+    h.update('\n');
+    h.update(String(Math.floor(f.mtimeMs)));
+    h.update('\n');
+  }
+  return h.digest('hex').slice(0, 8);
+}
+
+async function zipDirWithTopFolder({ srcDir, outDir, topFolderName }) {
+  fs.mkdirSync(outDir, { recursive: true });
+  const zipFileName = `${sanitizeFileName(topFolderName)}.zip`;
+  const zipPath = path.join(outDir, zipFileName);
+
+  await new Promise((resolve, reject) => {
+    const output = fs.createWriteStream(zipPath);
+    const archive = archiver('zip', { zlib: { level: 9 } });
+
+    output.on('close', resolve);
+    output.on('error', reject);
+    archive.on('warning', (err) => {
+      // 非致命 warning（如 ENOENT）按 warning 处理；其它仍抛出
+      if (err && err.code === 'ENOENT') return;
+      reject(err);
+    });
+    archive.on('error', reject);
+
+    archive.pipe(output);
+
+    // 把 srcDir 内容放到 zip 的顶层目录 topFolderName 下
+    archive.directory(srcDir, topFolderName);
+    archive.finalize();
+  });
+
+  return { zipPath };
+}
+
+function resolveDeployConfig(overrides = {}) {
+  const projectConfig = readProjectConfig();
+  const deploy = (projectConfig && projectConfig.deploy) || {};
+
+  const cfg = {
+    host: overrides.host ?? deploy.host,
+    port: String(overrides.port ?? deploy.port ?? '22'),
+    username: overrides.username ?? deploy.username,
+    password: overrides.password ?? deploy.password,
+    localDir: overrides.localDir ?? deploy.localDir ?? './EXTERNAL_DIGIC',
+    remoteDir: overrides.remoteDir ?? deploy.remoteDir ?? '/usr/local/nginx/html/EXTERNAL_DIGIC',
+  };
+
+  return cfg;
+}
+
+/**
+ * 执行部署（递归上传目录到远端）
+ * 测试服：压缩 + 上传 zip
+ * 正式服：只压缩（不上传）
+ * @param {{env?:'test'|'prod',host?:string,port?:string|number,username?:string,password?:string,localDir?:string,remoteDir?:string}} overrides
+ */
+async function deploy(overrides = {}) {
+  const cfg = resolveDeployConfig(overrides);
+  const localFolderPath = cfg.localDir;
+  const remoteFolderPath = cfg.remoteDir;
+
+  // 选择部署环境（prompts）
+  let env = overrides.env;
+  if (!env) {
+    const ans = await prompts({
+      type: 'select',
+      name: 'env',
+      message: '请选择部署环境',
+      choices: [
+        { title: '测试服（压缩 + 上传）', value: 'test' },
+        { title: '正式服（只压缩）', value: 'prod' },
+      ],
+      initial: 0,
+    });
+    env = ans.env;
+  }
+  if (env !== 'test' && env !== 'prod') {
+    throw new Error(`不支持的 env：${env}（仅支持 test/prod）`);
+  }
+
+  if (!fs.existsSync(localFolderPath)) {
+    throw new Error(`本地目录不存在：${path.resolve(localFolderPath)}`);
+  }
+
+  // buildDir：使用本地目录名（最后一段）
+  const buildDirName = path.basename(path.resolve(localFolderPath));
+  const ts = formatTimestampForFolderName(new Date());
+  const hash = computeDirHashShort(localFolderPath);
+  const topFolderName = `${buildDirName}-${ts}-${hash}`;
+
+  // zip 输出目录（本地）
+  const zipOutDir = path.join(process.cwd(), '.ylyx-deploy');
+
+  spinner = ora('开始压缩...').start();
+  const { zipPath } = await zipDirWithTopFolder({
+    srcDir: localFolderPath,
+    outDir: zipOutDir,
+    topFolderName,
+  });
+  spinner.succeed(`压缩完成：${path.relative(process.cwd(), zipPath)}`);
+
+  if (env === 'prod') {
+    console.log(`正式服：仅压缩不上传。zip 顶层目录名：${topFolderName}`);
+    return;
+  }
+
+  // test 环境需要上传
+  if (!cfg.host) throw new Error('缺少 deploy.host（测试服上传需要，在 .ylyxrc.json 的 deploy 字段配置）');
+  if (!cfg.username) throw new Error('缺少 deploy.username（测试服上传需要，在 .ylyxrc.json 的 deploy 字段配置）');
+  if (!cfg.password) throw new Error('缺少 deploy.password（测试服上传需要，在 .ylyxrc.json 的 deploy 字段配置）');
+  if (!remoteFolderPath) throw new Error('缺少 deploy.remoteDir（测试服上传需要，在 .ylyxrc.json 的 deploy 字段配置）');
+
+  let Client;
+  try {
+    // 仅在需要“上传”时才加载，避免“正式服只压缩”也因为缺依赖而崩
+    Client = require('ssh2-sftp-client');
+  } catch (e) {
+    throw new Error(
+      "缺少依赖：ssh2-sftp-client。\n" +
+        "如果你在 ylyx-cli 仓库本地跑：请先在 ylyx-cli 目录执行 `npm i`。\n" +
+        "如果你用 npx：请确认你运行的是已发布且包含依赖的版本，或清理 npx 缓存后重试。"
+    );
+  }
+
+  const sftp = new Client();
+  try {
+    spinner = ora('连接服务器...').start();
+    await sftp.connect({
+      host: cfg.host,
+      port: cfg.port,
+      username: cfg.username,
+      password: cfg.password,
+    });
+
+    spinner.text = '确保远端目录存在...';
+    await sftp.mkdir(remoteFolderPath, true);
+
+    const remoteZipPath = path.posix.join(
+      remoteFolderPath.replace(/\\/g, '/'),
+      path.basename(zipPath)
+    );
+
+    spinner.text = '开始上传 zip...';
+    // fastPut 对单文件更快；若目标路径不存在会失败，所以先 mkdir 上面做了
+    await sftp.fastPut(zipPath, remoteZipPath);
+    spinner.succeed(`测试服上传成功：${remoteZipPath}`);
+  } catch (err) {
+    if (spinner) spinner.fail('部署失败');
+    throw err;
+  } finally {
+    try {
+      await sftp.end();
+    } catch (e) {}
+    if (spinner) spinner.info('部署结束');
+  }
+}
+
+module.exports = {
+  deploy,
+  resolveDeployConfig,
+};
+
+// 允许直接 node lib/deploy.js 运行（从 .ylyxrc.json 读取 deploy 配置）
+if (require.main === module) {
+  deploy().catch((e) => {
+    console.error(e);
+    process.exit(1);
+  });
+}

package/lib/utils.js

@@ -79,6 +79,19 @@ function getOutputDir(customOutputDir) {
 	return process.cwd();
 }
 
+/**
+ * 读取当前项目目录下的 .ylyxrc.json（安全：不存在返回 {}，JSON 错误抛出）
+ */
+function readProjectConfig() {
+	const configPath = path.join(process.cwd(), '.ylyxrc.json');
+	if (!fs.existsSync(configPath)) return {};
+	try {
+		return fs.readJsonSync(configPath);
+	} catch (e) {
+		throw new Error(`读取 .ylyxrc.json 失败，请确认它是有效 JSON：${e.message}`);
+	}
+}
+
 /**
  * 注册 Handlebars 辅助函数
  */
@@ -129,6 +142,7 @@ module.exports = {
 	snakeCase,
 	getTemplatesDir,
 	getOutputDir,
+	readProjectConfig,
 	registerHandlebarsHelpers,
 	log,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ylyx-cli",
-    "version": "1.0.2",
+    "version": "1.0.4",
     "description": "公司内部代码生成模板脚手架工具，支持快速生成项目初始结构和代码模板",
     "main": "lib/index.js",
     "bin": {
@@ -43,12 +43,16 @@
         "node": ">=12.0.0"
     },
     "dependencies": {
+        "archiver": "^5.3.2",
         "commander": "^11.1.0",
         "inquirer": "^8.2.6",
         "chalk": "^4.1.2",
         "fs-extra": "^11.2.0",
         "handlebars": "^4.7.8",
-        "glob": "^10.3.10"
+        "glob": "^10.3.10",
+        "ora": "^5.4.1",
+        "prompts": "^2.4.2",
+        "ssh2-sftp-client": "^9.0.4"
     },
     "devDependencies": {
         "@types/node": "^20.10.0"