ylyx-cli 1.0.16 → 1.1.0

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/lib/generator.js

@@ -1,192 +1,192 @@
-const fs = require('fs-extra');
-const path = require('path');
-const handlebars = require('handlebars');
-const glob = require('glob');
-const { minimatch } = require('minimatch');
-const { registerHandlebarsHelpers, log } = require('./utils');
-
-// 注册 Handlebars 辅助函数
-registerHandlebarsHelpers(handlebars);
-
-/**
- * 判断文件是否需要 Handlebars 处理
- */
-function shouldProcessFile(filePath, templateConfig = {}) {
-	const filePathNormalized = filePath.replace(/\\/g, '/'); // 统一使用正斜杠
-
-	// 如果配置了 skipFiles（黑名单），先检查是否应该跳过
-	if (templateConfig.skipFiles && Array.isArray(templateConfig.skipFiles)) {
-		const shouldSkip = templateConfig.skipFiles.some((pattern) => {
-			if (typeof pattern === 'string') {
-				return minimatch(filePathNormalized, pattern, { matchBase: true });
-			}
-			return false;
-		});
-		if (shouldSkip) {
-			return false; // 在黑名单中，不处理
-		}
-	}
-
-	// 如果配置了 processFiles（白名单），只处理列表中的文件
-	if (templateConfig.processFiles && Array.isArray(templateConfig.processFiles)) {
-		const inWhitelist = templateConfig.processFiles.some((pattern) => {
-			if (typeof pattern === 'string') {
-				// 支持通配符匹配，使用 matchBase 以便匹配文件名
-				return minimatch(filePathNormalized, pattern, { matchBase: true });
-			}
-			return false;
-		});
-		return inWhitelist; // 在白名单中返回 true，不在返回 false
-	}
-
-	// 默认策略：只处理常见的配置文件和文档文件
-	// 跳过代码文件（可能包含 Vue/React 模板语法）
-	const processExtensions = ['.json', '.md', '.html', '.txt', '.yml', '.yaml', '.env'];
-	const processBasenames = ['.gitignore', '.editorconfig', '.prettierignore', '.eslintignore'];
-	const skipExtensions = ['.vue', '.js', '.ts', '.jsx', '.tsx', '.css', '.scss', '.less', '.sass', '.styl'];
-
-	const ext = path.extname(filePath).toLowerCase();
-	const basename = path.basename(filePath).toLowerCase();
-
-	// 如果文件扩展名在跳过列表中，不处理
-	if (skipExtensions.includes(ext)) {
-		return false;
-	}
-
-	// 如果文件扩展名或文件名在处理列表中，处理
-	if (processExtensions.includes(ext) || processBasenames.includes(basename)) {
-		return true;
-	}
-
-	// 默认不处理（安全起见，避免破坏代码文件）
-	return false;
-}
-
-/**
- * 处理文件内容，替换模板变量
- */
-function processFileContent(content, variables) {
-	try {
-		const template = handlebars.compile(content, { noEscape: true, strict: false });
-		return template(variables);
-	} catch (e) {
-		// 如果处理失败，返回原内容（避免因为 Vue 模板语法等导致失败）
-		// 注意：这个函数只应该在 shouldProcessFile 返回 true 时调用
-		// 如果还是失败了（比如文件中有复杂语法），返回原内容
-		return content;
-	}
-}
-
-/**
- * 处理文件名，替换模板变量
- */
-function processFileName(fileName, variables) {
-	try {
-		// 使用 Handlebars 处理文件名，支持 helper 函数
-		const template = handlebars.compile(fileName, { noEscape: true, strict: false });
-		return template(variables);
-	} catch (e) {
-		// 如果 Handlebars 编译失败，尝试简单字符串替换
-		let result = fileName;
-		Object.keys(variables).forEach((key) => {
-			if (typeof variables[key] === 'string') {
-				const pattern = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
-				result = result.replace(pattern, variables[key]);
-			}
-		});
-		return result;
-	}
-}
-
-/**
- * 获取模板文件列表
- */
-function getTemplateFiles(templatePath) {
-	const filesDir = path.join(templatePath, 'files');
-
-	if (!fs.existsSync(filesDir)) {
-		throw new Error(`模板文件目录不存在: ${filesDir}`);
-	}
-
-	// 使用 glob 匹配所有文件（排除 node_modules 等）
-	// 在 Windows 上，glob 需要正斜杠路径
-	const pattern = path.join(filesDir, '**', '*').replace(/\\/g, '/');
-	const files = glob.sync(pattern, {
-		dot: true,
-		nodir: true,
-		ignore: ['**/node_modules/**', '**/.git/**'],
-	});
-
-	return files.map((file) => {
-		// glob 返回的是绝对路径
-		return {
-			absolutePath: file,
-			relativePath: path.relative(filesDir, file),
-		};
-	});
-}
-
-/**
- * 生成代码文件
- */
-async function generateFiles(templatePath, outputDir, variables, templateConfig = {}) {
-	const files = getTemplateFiles(templatePath);
-
-	if (files.length === 0) {
-		log.warn('模板中没有找到文件');
-		return;
-	}
-
-	log.info(`开始生成 ${files.length} 个文件...\n`);
-
-	for (const file of files) {
-		try {
-			// 读取文件内容
-			const content = fs.readFileSync(file.absolutePath, 'utf-8');
-
-			// 判断是否需要 Handlebars 处理
-			// 默认只处理配置文件（如 .json, .md），跳过代码文件（如 .vue, .js）避免冲突
-			const needProcess = shouldProcessFile(file.relativePath, templateConfig);
-			const processedContent = needProcess ? processFileContent(content, variables) : content;
-
-			// 处理文件名
-			let processedFileName = file.relativePath;
-
-			// 如果配置了 fileMappings，优先使用映射
-			if (templateConfig.fileMappings) {
-				const fileName = path.basename(file.relativePath);
-				const dirName = path.dirname(file.relativePath);
-				if (templateConfig.fileMappings[fileName]) {
-					const mappedName = processFileName(templateConfig.fileMappings[fileName], variables);
-					processedFileName = dirName !== '.' ? path.join(dirName, mappedName) : mappedName;
-				} else {
-					processedFileName = processFileName(file.relativePath, variables);
-				}
-			} else {
-				processedFileName = processFileName(file.relativePath, variables);
-			}
-
-			// 生成目标文件路径
-			const targetPath = path.join(outputDir, processedFileName);
-			const targetDir = path.dirname(targetPath);
-
-			// 确保目录存在
-			fs.ensureDirSync(targetDir);
-
-			// 写入文件
-			fs.writeFileSync(targetPath, processedContent, 'utf-8');
-
-			log.success(`生成: ${processedFileName}`);
-		} catch (e) {
-			log.error(`处理文件失败 ${file.relativePath}: ${e.message}`);
-			throw e;
-		}
-	}
-
-	console.log('');
-	log.success('代码生成完成！');
-}
-
-module.exports = {
-	generateFiles,
-};
+const fs = require('fs-extra');
+const path = require('path');
+const handlebars = require('handlebars');
+const glob = require('glob');
+const { minimatch } = require('minimatch');
+const { registerHandlebarsHelpers, log } = require('./utils');
+
+// 注册 Handlebars 辅助函数
+registerHandlebarsHelpers(handlebars);
+
+/**
+ * 判断文件是否需要 Handlebars 处理
+ */
+function shouldProcessFile(filePath, templateConfig = {}) {
+	const filePathNormalized = filePath.replace(/\\/g, '/'); // 统一使用正斜杠
+
+	// 如果配置了 skipFiles（黑名单），先检查是否应该跳过
+	if (templateConfig.skipFiles && Array.isArray(templateConfig.skipFiles)) {
+		const shouldSkip = templateConfig.skipFiles.some((pattern) => {
+			if (typeof pattern === 'string') {
+				return minimatch(filePathNormalized, pattern, { matchBase: true });
+			}
+			return false;
+		});
+		if (shouldSkip) {
+			return false; // 在黑名单中，不处理
+		}
+	}
+
+	// 如果配置了 processFiles（白名单），只处理列表中的文件
+	if (templateConfig.processFiles && Array.isArray(templateConfig.processFiles)) {
+		const inWhitelist = templateConfig.processFiles.some((pattern) => {
+			if (typeof pattern === 'string') {
+				// 支持通配符匹配，使用 matchBase 以便匹配文件名
+				return minimatch(filePathNormalized, pattern, { matchBase: true });
+			}
+			return false;
+		});
+		return inWhitelist; // 在白名单中返回 true，不在返回 false
+	}
+
+	// 默认策略：只处理常见的配置文件和文档文件
+	// 跳过代码文件（可能包含 Vue/React 模板语法）
+	const processExtensions = ['.json', '.md', '.html', '.txt', '.yml', '.yaml', '.env'];
+	const processBasenames = ['.gitignore', '.editorconfig', '.prettierignore', '.eslintignore'];
+	const skipExtensions = ['.vue', '.js', '.ts', '.jsx', '.tsx', '.css', '.scss', '.less', '.sass', '.styl'];
+
+	const ext = path.extname(filePath).toLowerCase();
+	const basename = path.basename(filePath).toLowerCase();
+
+	// 如果文件扩展名在跳过列表中，不处理
+	if (skipExtensions.includes(ext)) {
+		return false;
+	}
+
+	// 如果文件扩展名或文件名在处理列表中，处理
+	if (processExtensions.includes(ext) || processBasenames.includes(basename)) {
+		return true;
+	}
+
+	// 默认不处理（安全起见，避免破坏代码文件）
+	return false;
+}
+
+/**
+ * 处理文件内容，替换模板变量
+ */
+function processFileContent(content, variables) {
+	try {
+		const template = handlebars.compile(content, { noEscape: true, strict: false });
+		return template(variables);
+	} catch (e) {
+		// 如果处理失败，返回原内容（避免因为 Vue 模板语法等导致失败）
+		// 注意：这个函数只应该在 shouldProcessFile 返回 true 时调用
+		// 如果还是失败了（比如文件中有复杂语法），返回原内容
+		return content;
+	}
+}
+
+/**
+ * 处理文件名，替换模板变量
+ */
+function processFileName(fileName, variables) {
+	try {
+		// 使用 Handlebars 处理文件名，支持 helper 函数
+		const template = handlebars.compile(fileName, { noEscape: true, strict: false });
+		return template(variables);
+	} catch (e) {
+		// 如果 Handlebars 编译失败，尝试简单字符串替换
+		let result = fileName;
+		Object.keys(variables).forEach((key) => {
+			if (typeof variables[key] === 'string') {
+				const pattern = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
+				result = result.replace(pattern, variables[key]);
+			}
+		});
+		return result;
+	}
+}
+
+/**
+ * 获取模板文件列表
+ */
+function getTemplateFiles(templatePath) {
+	const filesDir = path.join(templatePath, 'files');
+
+	if (!fs.existsSync(filesDir)) {
+		throw new Error(`模板文件目录不存在: ${filesDir}`);
+	}
+
+	// 使用 glob 匹配所有文件（排除 node_modules 等）
+	// 在 Windows 上，glob 需要正斜杠路径
+	const pattern = path.join(filesDir, '**', '*').replace(/\\/g, '/');
+	const files = glob.sync(pattern, {
+		dot: true,
+		nodir: true,
+		ignore: ['**/node_modules/**', '**/.git/**'],
+	});
+
+	return files.map((file) => {
+		// glob 返回的是绝对路径
+		return {
+			absolutePath: file,
+			relativePath: path.relative(filesDir, file),
+		};
+	});
+}
+
+/**
+ * 生成代码文件
+ */
+async function generateFiles(templatePath, outputDir, variables, templateConfig = {}) {
+	const files = getTemplateFiles(templatePath);
+
+	if (files.length === 0) {
+		log.warn('模板中没有找到文件');
+		return;
+	}
+
+	log.info(`开始生成 ${files.length} 个文件...\n`);
+
+	for (const file of files) {
+		try {
+			// 读取文件内容
+			const content = fs.readFileSync(file.absolutePath, 'utf-8');
+
+			// 判断是否需要 Handlebars 处理
+			// 默认只处理配置文件（如 .json, .md），跳过代码文件（如 .vue, .js）避免冲突
+			const needProcess = shouldProcessFile(file.relativePath, templateConfig);
+			const processedContent = needProcess ? processFileContent(content, variables) : content;
+
+			// 处理文件名
+			let processedFileName = file.relativePath;
+
+			// 如果配置了 fileMappings，优先使用映射
+			if (templateConfig.fileMappings) {
+				const fileName = path.basename(file.relativePath);
+				const dirName = path.dirname(file.relativePath);
+				if (templateConfig.fileMappings[fileName]) {
+					const mappedName = processFileName(templateConfig.fileMappings[fileName], variables);
+					processedFileName = dirName !== '.' ? path.join(dirName, mappedName) : mappedName;
+				} else {
+					processedFileName = processFileName(file.relativePath, variables);
+				}
+			} else {
+				processedFileName = processFileName(file.relativePath, variables);
+			}
+
+			// 生成目标文件路径
+			const targetPath = path.join(outputDir, processedFileName);
+			const targetDir = path.dirname(targetPath);
+
+			// 确保目录存在
+			fs.ensureDirSync(targetDir);
+
+			// 写入文件
+			fs.writeFileSync(targetPath, processedContent, 'utf-8');
+
+			log.success(`生成: ${processedFileName}`);
+		} catch (e) {
+			log.error(`处理文件失败 ${file.relativePath}: ${e.message}`);
+			throw e;
+		}
+	}
+
+	console.log('');
+	log.success('代码生成完成！');
+}
+
+module.exports = {
+	generateFiles,
+};