ylyx-cli 1.0.13 → 1.0.15

package/README.md

@@ -2,6 +2,8 @@
 
 公司内部使用的项目脚手架工具：支持交互式/命令式生成项目与代码模板，并提供 `.ylyxrc.json` 项目配置、环境配置切换（`isDev`）、以及一键部署（测试服上传/正式服打包压缩）等能力。
 
+> 说明：当前部署/配置切换能力**暂时只针对 Vue2 项目约定**（如 `.env.production` 的 `VUE_APP_PUBLIC_URL` 等）。其它技术栈/项目结构可能需要你根据实际情况调整 `.ylyxrc.json` 与相关路径配置。
+
 ## 功能特性
 
 - 🚀 **快速生成项目代码**：内置多种模板，一键生成项目/组件/模块代码
@@ -161,6 +163,10 @@ prod 输出目录规则：
 
 `localDir` 默认推导优先级：`deploy.localDir` → `.env.production` 的 `VUE_APP_PUBLIC_URL` → `.ylyxrc.json` 的 `buildDir`。
 
+### 上传日志
+
+每次执行 `deploy` 会在本地生成一份日志，默认在 `./.ylyx-deploy/logs/`，包含上传/压缩过程与错误信息，便于追溯。
+
 ### 命令
 
 ```bash

package/lib/deploy.js

@@ -18,6 +18,17 @@ function formatTimestampCompact(date = new Date()) {
   return `${yyyy}${MM}${dd}${HH}${mm}${ss}`;
 }
 
+function formatTimestampForLog(date = new Date()) {
+  const pad2 = (n) => String(n).padStart(2, '0');
+  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 formatBytes(bytes) {
   const n = Number(bytes) || 0;
   const units = ['B', 'KB', 'MB', 'GB', 'TB'];
@@ -31,6 +42,44 @@ function formatBytes(bytes) {
   return `${v.toFixed(fixed)}${units[i]}`;
 }
 
+function createDeployLogger({ env, buildDirName, outDir }) {
+  const logDir = path.join(outDir || path.join(process.cwd(), '.ylyx-deploy'), 'logs');
+  fs.ensureDirSync(logDir);
+  const fileName = `deploy-${env || 'unknown'}-${buildDirName || 'build'}-${formatTimestampCompact(
+    new Date()
+  )}.log`;
+  const logPath = path.join(logDir, fileName);
+  const stream = fs.createWriteStream(logPath, { flags: 'a' });
+
+  const log = (msg) => {
+    const line = `[${formatTimestampForLog(new Date())}] ${msg}\n`;
+    try {
+      stream.write(line);
+    } catch (e) {
+      // ignore
+    }
+  };
+
+  // 只记录“操作/目录/时间”的精简日志
+  const logOp = (op, target, extra) => {
+    const parts = [`op=${op}`];
+    if (target) parts.push(`target=${target}`);
+    if (extra) parts.push(`extra=${extra}`);
+    log(parts.join(' '));
+  };
+
+  const close = () =>
+    new Promise((resolve) => {
+      try {
+        stream.end(resolve);
+      } catch (e) {
+        resolve();
+      }
+    });
+
+  return { logPath, log, logOp, close };
+}
+
 function listLocalFilesWithSize(rootDir) {
   const out = [];
   const stack = [rootDir];
@@ -254,8 +303,16 @@ function resolveDeployConfig(overrides = {}) {
   const inferredLocalDir =
     deploy.localDir ||
     inferredFromEnvProd ||
-    (projectConfig && projectConfig.buildDir ? path.resolve(process.cwd(), projectConfig.buildDir) : null) ||
-    './EXTERNAL_DIGIC';
+    (projectConfig && projectConfig.buildDir ? path.resolve(process.cwd(), projectConfig.buildDir) : null);
+
+  if (!inferredLocalDir) {
+    throw new Error(
+      '无法确定 deploy.localDir（本地打包目录）。请设置以下任意一种：\n' +
+        '- 在 .ylyxrc.json 配置 deploy.localDir\n' +
+        '- 在项目 .env.production 配置 VUE_APP_PUBLIC_URL（相对路径，如 /dist/app/）\n' +
+        '- 在 .ylyxrc.json 配置 buildDir（可相对/绝对路径）'
+    );
+  }
 
   const cfg = {
     env: overrides.env ?? deploy.env,
@@ -265,7 +322,7 @@ function resolveDeployConfig(overrides = {}) {
     username: overrides.username ?? deploy.username,
     password: overrides.password ?? deploy.password,
     localDir: overrides.localDir ?? inferredLocalDir,
-    remoteDir: overrides.remoteDir ?? deploy.remoteDir ?? '/usr/local/nginx/html/EXTERNAL_DIGIC',
+    remoteDir: overrides.remoteDir ?? deploy.remoteDir,
     zipAfter: overrides.zipAfter ?? deploy.zipAfter ?? false,
     zipOutDir: overrides.zipOutDir ?? deploy.zipOutDir ?? path.join(process.cwd(), '.ylyx-deploy'),
   };
@@ -285,14 +342,21 @@ async function deploy(overrides = {}) {
   const remoteFolderPath = cfg.remoteDir;
 
   const env = await chooseDeployEnv(cfg.env);
+  const buildDirNameForLog = getBuildDirBaseName({ buildDir: cfg.buildDir, localDir: localFolderPath });
+  const logger = createDeployLogger({ env, buildDirName: buildDirNameForLog, outDir: cfg.zipOutDir });
+  logger.logOp('DEPLOY_START', '', `env=${env}`);
+  logger.logOp('LOCAL_DIR', localFolderPath);
+  if (remoteFolderPath) logger.logOp('REMOTE_DIR', remoteFolderPath);
 
   if (!fs.existsSync(localFolderPath)) {
+    logger.logOp('ERROR', localFolderPath, 'localDir_not_exists');
+    await logger.close();
     throw new Error(`本地目录不存在：${path.resolve(localFolderPath)}`);
   }
 
   // 正式服：仅压缩
   if (env === 'prod') {
-    const buildDirName = getBuildDirBaseName({ buildDir: cfg.buildDir, localDir: localFolderPath });
+    const buildDirName = buildDirNameForLog;
     const ts = formatTimestampCompact(new Date());
     const hashLetters = computeDirHashLetters(localFolderPath); // 纯字母
     // 优化命名：更可读、更易分割（buildDir-时间-哈希）
@@ -300,15 +364,21 @@ async function deploy(overrides = {}) {
     fs.ensureDirSync(cfg.zipOutDir);
     const zipName = `${zipBaseName}.zip`;
     const zipPath = path.join(cfg.zipOutDir, zipName);
+    logger.logOp('ZIP_START', zipPath);
 
     const zipSpinner = ora(`开始压缩：${zipName}`).start();
     try {
       await zipDirAsTopFolder({ srcDir: localFolderPath, zipPath, topFolderName: buildDirName });
       zipSpinner.succeed(`压缩完成：${path.relative(process.cwd(), zipPath)}`);
+      logger.logOp('ZIP_DONE', zipPath);
     } catch (e) {
       zipSpinner.fail('压缩失败');
+      logger.logOp('ERROR', zipPath, `zip_failed:${e && e.message ? e.message : String(e)}`);
+      await logger.close();
       throw e;
     }
+    logger.logOp('DEPLOY_END', '', 'prod');
+    await logger.close();
     return;
   }
 
@@ -316,7 +386,11 @@ async function deploy(overrides = {}) {
   if (!cfg.host) throw new Error('缺少 deploy.host（测试服上传需要）');
   if (!cfg.username) throw new Error('缺少 deploy.username（测试服上传需要）');
   if (!cfg.password) throw new Error('缺少 deploy.password（测试服上传需要）');
-  if (!remoteFolderPath) throw new Error('缺少 deploy.remoteDir（测试服上传需要）');
+  if (!remoteFolderPath) {
+    logger.logOp('ERROR', '', 'missing_remoteDir');
+    await logger.close();
+    throw new Error('缺少 deploy.remoteDir（测试服上传需要）：请在 .ylyxrc.json 的 deploy.remoteDir 配置远端部署目录');
+  }
 
   let Client;
   try {
@@ -332,6 +406,7 @@ async function deploy(overrides = {}) {
   const sftp = new Client();
   try {
     spinner = ora('连接服务器...').start();
+    logger.logOp('SFTP_CONNECT', cfg.host, `port=${cfg.port} username=${cfg.username}`);
     await sftp.connect({
       host: cfg.host,
       port: cfg.port,
@@ -340,15 +415,20 @@ async function deploy(overrides = {}) {
     });
 
     spinner.text = '服务器连接成功，准备清理远端目录...';
+    logger.logOp('REMOTE_DELETE_START', remoteFolderPath);
     try {
       await sftp.rmdir(remoteFolderPath, true);
+      logger.logOp('REMOTE_DELETE_DONE', remoteFolderPath);
     } catch (e) {
       // ignore
+      logger.logOp('REMOTE_DELETE_SKIP', remoteFolderPath, e && e.message ? e.message : 'ignored');
     }
     await sftp.mkdir(remoteFolderPath, true);
+    logger.logOp('REMOTE_MKDIR', remoteFolderPath);
 
     const remoteDirPosix = remoteFolderPath.replace(/\\/g, '/');
     spinner.text = '开始上传目录...';
+    logger.logOp('UPLOAD_START', remoteDirPosix, `from=${localFolderPath}`);
     const { uploadedBytes, totalBytes, fileCount } = await uploadDirWithProgress({
       sftp,
       localDir: localFolderPath,
@@ -360,8 +440,11 @@ async function deploy(overrides = {}) {
       },
     });
     spinner.succeed(`上传成功：${formatBytes(uploadedBytes)}/${formatBytes(totalBytes)}，共 ${fileCount} 个文件`);
+    logger.logOp('UPLOAD_DONE', remoteDirPosix, `files=${fileCount} bytes=${uploadedBytes}/${totalBytes}`);
   } catch (err) {
     if (spinner) spinner.fail('部署失败');
+    logger.logOp('ERROR', '', err && err.message ? err.message : String(err));
+    await logger.close();
     throw err;
   } finally {
     try {
@@ -372,23 +455,30 @@ async function deploy(overrides = {}) {
 
   // 测试服可选：部署后压缩（延续之前的可选开关）
   if (cfg.zipAfter) {
-    const buildDirName = getBuildDirBaseName({ buildDir: cfg.buildDir, localDir: localFolderPath });
+    const buildDirName = buildDirNameForLog;
     const ts = formatTimestampCompact(new Date());
     const hashLetters = computeDirHashLetters(localFolderPath); // 纯字母
     const zipBaseName = `${buildDirName}-${ts}-${hashLetters}`;
     fs.ensureDirSync(cfg.zipOutDir);
     const zipName = `${zipBaseName}.zip`;
     const zipPath = path.join(cfg.zipOutDir, zipName);
+    logger.logOp('ZIP_START', zipPath);
 
     const zipSpinner = ora(`开始压缩：${zipName}`).start();
     try {
       await zipDirAsTopFolder({ srcDir: localFolderPath, zipPath, topFolderName: buildDirName });
       zipSpinner.succeed(`压缩完成：${path.relative(process.cwd(), zipPath)}`);
+      logger.logOp('ZIP_DONE', zipPath);
     } catch (e) {
       zipSpinner.fail('压缩失败');
+      logger.logOp('ERROR', zipPath, `zip_failed:${e && e.message ? e.message : String(e)}`);
+      await logger.close();
       throw e;
     }
   }
+
+  logger.logOp('DEPLOY_END', '', 'test');
+  await logger.close();
 }
 
 module.exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ylyx-cli",
-    "version": "1.0.13",
+    "version": "1.0.15",
     "description": "公司内部代码生成模板脚手架工具，支持快速生成项目初始结构和代码模板",
     "main": "lib/index.js",
     "bin": {