ylyx-cli 1.0.15 → 1.1.0

package/lib/deploy.js

@@ -4,6 +4,7 @@ const ora = require('ora');
 const inquirer = require('inquirer');
 const archiver = require('archiver');
 const { readProjectConfig } = require('./utils');
+const { assertConfigMigrated, findEnvironment, getConfigPath } = require('./environments');
 
 let spinner = null; // 加载实例
 
@@ -123,6 +124,40 @@ function getBuildDirBaseName({ buildDir, localDir }) {
   return sanitizeBuildDirName(path.basename(path.resolve(localDir || process.cwd())));
 }
 
+function normalizeAndValidateRemoteDir(remoteDir) {
+  if (!remoteDir || typeof remoteDir !== 'string') return null;
+  // 统一成 Linux 风格
+  const raw = remoteDir.trim().replace(/\\/g, '/');
+  // 必须是绝对路径
+  if (!raw.startsWith('/')) {
+    throw new Error(
+      `deploy.remoteDir 必须是 Linux 绝对路径，并且只能在 /usr/local/nginx/html/* 下（当前: ${remoteDir})`
+    );
+  }
+
+  // 归一化，消除 .. 等
+  const resolved = path.posix.resolve(raw);
+  const base = '/usr/local/nginx/html';
+  const baseWithSlash = base + '/';
+
+  // 只允许 /usr/local/nginx/html/*（必须是子目录，不允许刚好等于 base）
+  if (!resolved.startsWith(baseWithSlash)) {
+    throw new Error(
+      `deploy.remoteDir 只能设置为 ${baseWithSlash}* 下的目录（当前: ${resolved}）`
+    );
+  }
+  if (resolved === base) {
+    throw new Error(`deploy.remoteDir 不能是 ${base} 根目录，请设置为其子目录（例如 ${baseWithSlash}my-app）`);
+  }
+  // 再防一次：禁止路径段包含 ..（即便 resolve 已处理，这里保证输入约束更明确）
+  const rel = resolved.slice(baseWithSlash.length);
+  if (!rel || rel.split('/').some((seg) => seg === '..')) {
+    throw new Error(`deploy.remoteDir 非法：不允许包含 ..（当前: ${resolved}）`);
+  }
+
+  return resolved;
+}
+
 async function zipDirAsTopFolder({ srcDir, zipPath, topFolderName }) {
   fs.ensureDirSync(path.dirname(zipPath));
   await new Promise((resolve, reject) => {
@@ -172,18 +207,34 @@ function computeDirHashLetters(localDir) {
   return hashLettersFromSha256(digest, 12);
 }
 
-async function chooseDeployEnv(env) {
-  if (env === 'test' || env === 'prod') return env;
+// 注意：这里"环境不存在或不可部署"的判断逻辑与 resolveDeployConfig 内部的
+// findEnvironment + deployMethod==='none' 检查在语义上等价，只是分别在
+// "交互选择阶段"和"最终解析阶段"各自独立校验一次（后者作为独立导出函数，
+// 必须能脱离 chooseDeployEnv 单独工作，因此不合并成一个函数）。
+async function chooseDeployEnv(projectConfig, envArg) {
+  const environments = (projectConfig.environments || []).filter((e) => e.deployMethod !== 'none');
+
+  if (envArg) {
+    if (!environments.some((e) => e.name === envArg)) {
+      const available = environments.map((e) => e.name).join(', ') || '(无)';
+      throw new Error(`环境 "${envArg}" 不可部署或不存在\n可部署环境: ${available}`);
+    }
+    return envArg;
+  }
+
+  if (environments.length === 0) {
+    throw new Error('没有可部署的环境（所有环境的 deployMethod 均为 none，或未定义 environments）');
+  }
+
   const ans = await inquirer.prompt([
     {
       type: 'list',
       name: 'env',
       message: '请选择部署环境',
-      choices: [
-        { name: '部署测试服（上传到服务器）', value: 'test' },
-        { name: '部署正式服（不上传，仅压缩）', value: 'prod' },
-      ],
-      default: 'test',
+      choices: environments.map((e) => ({
+        name: `${e.name}（${e.deployMethod === 'upload' ? '上传到服务器' : '仅压缩'}）`,
+        value: e.name,
+      })),
     },
   ]);
   return ans.env;
@@ -255,96 +306,60 @@ async function uploadDirWithProgress({ sftp, localDir, remoteDirPosix, onProgres
   return { totalBytes, uploadedBytes, fileCount: files.length };
 }
 
-function resolveDeployConfig(overrides = {}) {
-  const projectConfig = readProjectConfig();
-  const deploy = (projectConfig && projectConfig.deploy) || {};
-
-  function parseDotEnvFile(envPath) {
-    if (!fs.existsSync(envPath)) return {};
-    const content = fs.readFileSync(envPath, 'utf-8');
-    const lines = content.split(/\r?\n/);
-    const out = {};
-    for (const raw of lines) {
-      const line = raw.trim();
-      if (!line || line.startsWith('#')) continue;
-      const idx = line.indexOf('=');
-      if (idx < 0) continue;
-      const key = line.slice(0, idx).trim();
-      let value = line.slice(idx + 1).trim();
-      if (
-        (value.startsWith('"') && value.endsWith('"')) ||
-        (value.startsWith("'") && value.endsWith("'"))
-      ) {
-        value = value.slice(1, -1);
-      }
-      out[key] = value;
-    }
-    return out;
+function resolveDeployConfig(envName, overrides = {}, projectConfig) {
+  if (!projectConfig) {
+    projectConfig = readProjectConfig();
+    assertConfigMigrated(projectConfig, fs.existsSync(getConfigPath()));
   }
+  const env = findEnvironment(projectConfig, envName);
 
-  function normalizePublicUrlToDir(publicUrl) {
-    // 与 config.js 规则保持一致：忽略完整 URL；去掉首尾 /；把 \ 转 /
-    if (!publicUrl || typeof publicUrl !== 'string') return '';
-    let v = publicUrl.trim();
-    v = v.replace(/\\/g, '/');
-    if (/^https?:\/\//i.test(v)) return '';
-    v = v.replace(/^\/+/, '').replace(/\/+$/, '');
-    return v;
+  if (env.deployMethod === 'none') {
+    throw new Error(`环境 "${env.name}" 不支持部署（deployMethod=none）`);
   }
 
-  // localDir 默认优先从项目 .env.production 推导（VUE_APP_PUBLIC_URL -> 目录名）
-  const envProdPath = path.join(process.cwd(), '.env.production');
-  const envProd = parseDotEnvFile(envProdPath);
-  const publicUrlDir = normalizePublicUrlToDir(envProd.VUE_APP_PUBLIC_URL);
-  const inferredFromEnvProd = publicUrlDir ? path.resolve(process.cwd(), publicUrlDir) : null;
+  const buildDir = overrides.buildDir ?? env.buildDir;
+  const localDirRaw = overrides.localDir ?? env.localDir ?? buildDir;
+  const localDir = localDirRaw ? path.resolve(process.cwd(), localDirRaw) : null;
 
-  // localDir 默认使用项目 buildDir（打包输出目录）
-  // 规则：优先 deploy.localDir；否则使用 .env.production 的 VUE_APP_PUBLIC_URL；否则使用 .ylyxrc.json 的 buildDir；最后才回退 ./EXTERNAL_DIGIC
-  const inferredLocalDir =
-    deploy.localDir ||
-    inferredFromEnvProd ||
-    (projectConfig && projectConfig.buildDir ? path.resolve(process.cwd(), projectConfig.buildDir) : null);
-
-  if (!inferredLocalDir) {
+  if (!localDir) {
     throw new Error(
-      '无法确定 deploy.localDir（本地打包目录）。请设置以下任意一种：\n' +
-        '- 在 .ylyxrc.json 配置 deploy.localDir\n' +
-        '- 在项目 .env.production 配置 VUE_APP_PUBLIC_URL（相对路径，如 /dist/app/）\n' +
-        '- 在 .ylyxrc.json 配置 buildDir（可相对/绝对路径）'
+      `无法确定环境 "${env.name}" 的本地目录（用于上传/压缩）。请在 .ylyxrc.json 该环境条目配置 localDir 或 buildDir`
     );
   }
 
   const cfg = {
-    env: overrides.env ?? deploy.env,
-    buildDir: overrides.buildDir ?? deploy.buildDir ?? projectConfig.buildDir,
-    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 ?? inferredLocalDir,
-    remoteDir: overrides.remoteDir ?? deploy.remoteDir,
-    zipAfter: overrides.zipAfter ?? deploy.zipAfter ?? false,
-    zipOutDir: overrides.zipOutDir ?? deploy.zipOutDir ?? path.join(process.cwd(), '.ylyx-deploy'),
+    name: env.name,
+    deployMethod: env.deployMethod,
+    buildDir,
+    host: overrides.host ?? env.host,
+    port: String(overrides.port ?? env.port ?? '22'),
+    username: overrides.username ?? env.username,
+    password: overrides.password ?? env.password,
+    localDir,
+    remoteDir: normalizeAndValidateRemoteDir(overrides.remoteDir ?? env.remoteDir),
+    zipAfter: overrides.zipAfter ?? env.zipAfter ?? false,
+    zipOutDir: path.resolve(process.cwd(), overrides.zipOutDir ?? env.zipOutDir ?? './.ylyx-deploy'),
   };
 
   return cfg;
 }
 
 /**
- * 执行部署（递归上传目录到远端）
- * 测试服：上传到服务器（可选部署后压缩）
- * 正式服：不上传，仅压缩
- * @param {{env?:'test'|'prod',host?:string,port?:string|number,username?:string,password?:string,localDir?:string,remoteDir?:string,zipAfter?:boolean,zipOutDir?:string}} overrides
+ * 执行部署（按环境的 deployMethod 分支：upload=SFTP 上传，zip=仅压缩）
+ * @param {{env?:string,host?:string,port?:string|number,username?:string,password?:string,localDir?:string,remoteDir?:string,zipAfter?:boolean,zipOutDir?:string,buildDir?:string}} overrides
  */
 async function deploy(overrides = {}) {
-  const cfg = resolveDeployConfig(overrides);
+  const projectConfig = readProjectConfig();
+  assertConfigMigrated(projectConfig, fs.existsSync(getConfigPath()));
+
+  const envName = await chooseDeployEnv(projectConfig, overrides.env);
+  const cfg = resolveDeployConfig(envName, overrides, projectConfig);
   const localFolderPath = cfg.localDir;
   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}`);
+  const logger = createDeployLogger({ env: cfg.name, buildDirName: buildDirNameForLog, outDir: cfg.zipOutDir });
+  logger.logOp('DEPLOY_START', '', `env=${cfg.name}`);
   logger.logOp('LOCAL_DIR', localFolderPath);
   if (remoteFolderPath) logger.logOp('REMOTE_DIR', remoteFolderPath);
 
@@ -354,12 +369,11 @@ async function deploy(overrides = {}) {
     throw new Error(`本地目录不存在：${path.resolve(localFolderPath)}`);
   }
 
-  // 正式服：仅压缩
-  if (env === 'prod') {
+  // deployMethod=zip：仅压缩，不上传
+  if (cfg.deployMethod === 'zip') {
     const buildDirName = buildDirNameForLog;
     const ts = formatTimestampCompact(new Date());
     const hashLetters = computeDirHashLetters(localFolderPath); // 纯字母
-    // 优化命名：更可读、更易分割（buildDir-时间-哈希）
     const zipBaseName = `${buildDirName}-${ts}-${hashLetters}`;
     fs.ensureDirSync(cfg.zipOutDir);
     const zipName = `${zipBaseName}.zip`;
@@ -377,19 +391,19 @@ async function deploy(overrides = {}) {
       await logger.close();
       throw e;
     }
-    logger.logOp('DEPLOY_END', '', 'prod');
+    logger.logOp('DEPLOY_END', '', cfg.name);
     await logger.close();
     return;
   }
 
-  // 测试服：上传到服务器
-  if (!cfg.host) throw new Error('缺少 deploy.host（测试服上传需要）');
-  if (!cfg.username) throw new Error('缺少 deploy.username（测试服上传需要）');
-  if (!cfg.password) throw new Error('缺少 deploy.password（测试服上传需要）');
+  // deployMethod=upload：上传到服务器
+  if (!cfg.host) throw new Error(`缺少环境 "${cfg.name}" 的 host（上传需要）`);
+  if (!cfg.username) throw new Error(`缺少环境 "${cfg.name}" 的 username（上传需要）`);
+  if (!cfg.password) throw new Error(`缺少环境 "${cfg.name}" 的 password（上传需要）`);
   if (!remoteFolderPath) {
     logger.logOp('ERROR', '', 'missing_remoteDir');
     await logger.close();
-    throw new Error('缺少 deploy.remoteDir（测试服上传需要）：请在 .ylyxrc.json 的 deploy.remoteDir 配置远端部署目录');
+    throw new Error(`缺少环境 "${cfg.name}" 的 remoteDir（上传需要）：请在 .ylyxrc.json 该环境条目配置 remoteDir`);
   }
 
   let Client;
@@ -453,7 +467,7 @@ async function deploy(overrides = {}) {
     if (spinner) spinner.info('部署结束');
   }
 
-  // 测试服可选：部署后压缩（延续之前的可选开关）
+  // 上传后可选：再压缩一份（延续之前的可选开关）
   if (cfg.zipAfter) {
     const buildDirName = buildDirNameForLog;
     const ts = formatTimestampCompact(new Date());
@@ -477,7 +491,7 @@ async function deploy(overrides = {}) {
     }
   }
 
-  logger.logOp('DEPLOY_END', '', 'test');
+  logger.logOp('DEPLOY_END', '', cfg.name);
   await logger.close();
 }
 

package/lib/environments.js

@@ -0,0 +1,111 @@
+const path = require('path');
+const fs = require('fs-extra');
+
+const CONFIG_VERSION = 2;
+
+function getConfigPath() {
+	return path.join(process.cwd(), '.ylyxrc.json');
+}
+
+function readConfigSafe(configPath) {
+	if (!fs.existsSync(configPath)) return {};
+	try {
+		return fs.readJsonSync(configPath);
+	} catch (e) {
+		throw new Error(`读取 .ylyxrc.json 失败，请确认它是有效 JSON：${e.message}`);
+	}
+}
+
+function isConfigMigrated(config) {
+	return !!config && typeof config.configVersion === 'number' && config.configVersion >= CONFIG_VERSION;
+}
+
+function assertConfigMigrated(config, configExists) {
+	if (!isConfigMigrated(config)) {
+		if (configExists === false) {
+			throw new Error(
+				'未找到 .ylyxrc.json 配置文件\n' +
+					'   请先运行以下命令初始化配置：\n' +
+					'   ylyx init config'
+			);
+		}
+		throw new Error(
+			'检测到旧版配置（.ylyxrc.json 缺少 configVersion）\n' +
+				'   请先运行以下命令完成迁移：\n' +
+				'   ylyx migrate config'
+		);
+	}
+}
+
+function findEnvironment(config, name) {
+	const environments = (config && config.environments) || [];
+	const env = environments.find((e) => e.name === name);
+	if (!env) {
+		const available = environments.map((e) => e.name).join(', ') || '(无)';
+		throw new Error(`环境不存在: ${name}\n可用环境: ${available}`);
+	}
+	return env;
+}
+
+/**
+ * 将旧版 .ylyxrc.json（mode/deploy/顶层 buildDir/preScripts）转换为新版 environments 结构
+ * 纯函数：不读写文件，方便单独验证
+ */
+function buildMigratedConfig(oldConfig) {
+	oldConfig = oldConfig || {};
+	const oldMode = oldConfig.mode === 'prod' ? 'prod' : 'dev';
+	const oldDeploy = oldConfig.deploy || {};
+	const oldPreScripts = oldConfig.preScripts || {};
+	const oldBuildDir = oldConfig.buildDir;
+
+	const devEnv = {
+		name: 'dev',
+		isLocal: true,
+		npmScript: oldPreScripts.dev || 'dev',
+		deployMethod: 'none',
+	};
+
+	const testEnv = {
+		name: 'test',
+		npmScript: 'build:test',
+		deployMethod: 'upload',
+		buildDir: oldDeploy.buildDir || oldBuildDir || '',
+		host: oldDeploy.host || '',
+		port: oldDeploy.port || '22',
+		username: oldDeploy.username || '',
+		password: oldDeploy.password || '',
+		localDir: oldDeploy.localDir || '',
+		remoteDir: oldDeploy.remoteDir || '',
+		zipAfter: oldDeploy.zipAfter || false,
+	};
+
+	const prodEnv = {
+		name: 'prod',
+		npmScript: oldPreScripts.prod || 'build:prod',
+		deployMethod: 'zip',
+		buildDir: oldBuildDir || '',
+		zipOutDir: oldDeploy.zipOutDir || './.ylyx-deploy',
+	};
+
+	const next = { ...oldConfig };
+	delete next.mode;
+	delete next.deploy;
+	delete next.buildDir;
+	delete next.preScripts;
+
+	next.configVersion = CONFIG_VERSION;
+	next.currentEnv = oldMode;
+	next.environments = [devEnv, testEnv, prodEnv];
+
+	return next;
+}
+
+module.exports = {
+	CONFIG_VERSION,
+	getConfigPath,
+	readConfigSafe,
+	isConfigMigrated,
+	assertConfigMigrated,
+	findEnvironment,
+	buildMigratedConfig,
+};

package/package.json

@@ -1,59 +1,61 @@
-{
-    "name": "ylyx-cli",
-    "version": "1.0.15",
-    "description": "公司内部代码生成模板脚手架工具，支持快速生成项目初始结构和代码模板",
-    "main": "lib/index.js",
-    "bin": {
-        "ylyx": "./bin/ylyx.js",
-        "ylyx-cli": "./bin/ylyx.js"
-    },
-    "files": [
-        "bin",
-        "lib",
-        "templates",
-        "README.md"
-    ],
-    "scripts": {
-        "start": "node bin/ylyx.js",
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "keywords": [
-        "cli",
-        "scaffold",
-        "code-generator",
-        "template",
-        "generator",
-        "scaffolding",
-        "boilerplate",
-        "project-template",
-        "vue",
-        "react"
-    ],
-    "author": "YLYX",
-    "license": "ISC",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/your-org/ylyx-cli.git"
-    },
-    "bugs": {
-        "url": "https://github.com/your-org/ylyx-cli/issues"
-    },
-    "homepage": "https://github.com/your-org/ylyx-cli#readme",
-    "engines": {
-        "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",
-        "ora": "^5.4.1",
-        "ssh2-sftp-client": "^9.0.4"
-    },
-    "devDependencies": {
-        "@types/node": "^20.10.0"
-    }
-}
+{
+    "name": "ylyx-cli",
+    "version": "1.1.0",
+    "description": "公司内部代码生成模板脚手架工具，支持快速生成项目初始结构和代码模板",
+    "main": "lib/index.js",
+    "bin": {
+        "ylyx": "./bin/ylyx.js",
+        "ylyx-cli": "./bin/ylyx.js"
+    },
+    "files": [
+        "bin",
+        "lib/**/*.js",
+        "!lib/**/*.test.js",
+        "templates",
+        "README.md"
+    ],
+    "scripts": {
+        "start": "node bin/ylyx.js",
+        "test": "jest"
+    },
+    "keywords": [
+        "cli",
+        "scaffold",
+        "code-generator",
+        "template",
+        "generator",
+        "scaffolding",
+        "boilerplate",
+        "project-template",
+        "vue",
+        "react"
+    ],
+    "author": "YLYX",
+    "license": "ISC",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/your-org/ylyx-cli.git"
+    },
+    "bugs": {
+        "url": "https://github.com/your-org/ylyx-cli/issues"
+    },
+    "homepage": "https://github.com/your-org/ylyx-cli#readme",
+    "engines": {
+        "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",
+        "ora": "^5.4.1",
+        "ssh2-sftp-client": "^9.0.4"
+    },
+    "devDependencies": {
+        "@types/node": "^20.10.0",
+        "jest": "^29.7.0"
+    }
+}

package/templates/react-app/files/.gitignore

@@ -0,0 +1,22 @@
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+

package/templates/vue-app/files/.gitignore

@@ -0,0 +1,24 @@
+.DS_Store
+node_modules/
+dist/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+**/*.log
+hospManage/
+EXTERNAL_HOSPITAL/
+tests/**/coverage/
+tests/e2e/reports
+selenium-debug.log
+
+# Editor directories and files
+.idea
+# .vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.local
+
+package-lock.json
+yarn.lock