ylyx-cli 1.0.0

package/README.md

@@ -0,0 +1,184 @@
+# YLYX CLI - 项目脚手架工具
+
+公司内部使用的项目脚手架工具，快速生成项目初始结构和代码模板。
+
+## 功能特性
+
+- 🚀 快速生成项目代码
+- 📦 模板化管理，易于维护和扩展
+- ⚙️ 支持自定义变量和配置
+- ☁️ 支持云端模板（GitHub/GitLab）
+- 📝 交互式命令行界面
+
+## 安装
+
+### 全局安装
+
+```bash
+npm install -g @ylyx/cli
+```
+
+### 使用 npx（推荐，无需安装）
+
+```bash
+# 使用 npx 直接运行
+npx @ylyx/cli create
+
+# 生成项目
+npx @ylyx/cli generate react-app -n my-project -o ./my-project
+
+# 安装远程模板
+npx @ylyx/cli install owner/repo
+```
+
+### 本地开发
+
+```bash
+git clone <repository>
+cd ylyx-cli
+npm install
+npm link  # 链接到全局，可以本地测试
+```
+
+## 使用方法
+
+### 快速开始
+
+使用交互式方式创建新项目（推荐）：
+
+```bash
+ylyx create
+```
+
+或者直接指定模板和项目名：
+
+```bash
+# 创建一个 React 项目
+ylyx generate react-app -n my-project -o ./my-project
+```
+
+### 查看可用模板
+
+```bash
+ylyx list
+```
+
+### 安装远程模板
+
+从 GitHub/GitLab 安装模板：
+
+```bash
+# 使用简写格式（GitHub）
+ylyx install owner/repo
+
+# 使用完整 URL
+ylyx install https://github.com/owner/repo
+
+# 指定分支和模板名
+ylyx install owner/repo -b develop -n my-template
+```
+
+### 添加本地模板
+
+```bash
+ylyx add template-name /path/to/template
+```
+
+### 查看模板详情
+
+```bash
+ylyx info template-name
+```
+
+## 云端模板
+
+模板可以放在 Git 仓库中（如 GitHub、GitLab），使用 `ylyx install` 命令安装。
+
+### 模板仓库要求
+
+模板仓库需要包含以下结构：
+
+```
+your-template/
+  template.json      # 模板配置文件（可选）
+  files/            # 模板文件目录
+    ...
+```
+
+### 示例
+
+```bash
+# 从 GitHub 安装模板
+ylyx install github-user/react-template
+
+# 从私有仓库安装（需要配置 SSH 密钥）
+ylyx install git@github.com:company/templates.git
+
+# 指定分支
+ylyx install owner/repo -b v2.0
+```
+
+## 模板配置
+
+模板应放在 `templates/` 目录下，结构如下：
+
+```
+templates/
+  template-name/
+    template.json      # 模板配置文件
+    files/            # 模板文件目录
+      example.js
+      example.css
+```
+
+### template.json 配置示例
+
+```json
+{
+	"name": "template-name",
+	"description": "模板描述",
+	"version": "1.0.0",
+	"variables": {
+		"projectName": {
+			"type": "input",
+			"message": "请输入项目名称",
+			"default": "my-project"
+		}
+	},
+	"processFiles": ["package.json", "README.md", "*.json"],
+	"skipFiles": ["**/*.vue", "**/*.js"]
+}
+```
+
+## 配置文件
+
+可以在项目根目录创建 `.ylyxrc.json` 配置文件：
+
+```json
+{
+	"templatesDir": "./templates",
+	"outputDir": "./src",
+	"defaultVariables": {
+		"author": "Your Name",
+		"company": "YLYX"
+	}
+}
+```
+
+## 示例
+
+### 生成完整项目
+
+```bash
+# 生成 React 项目
+ylyx generate react-app -n my-react-app -o ./my-react-app
+
+# 生成后进入目录并安装依赖
+cd my-react-app
+npm install
+npm start
+```
+
+## License
+
+ISC

package/bin/ylyx.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const { generate } = require('../lib/index');
+const { listTemplates, getTemplateInfo, addTemplate } = require('../lib/template');
+const { interactiveCreate } = require('../lib/interactive');
+const pkg = require('../package.json');
+
+program.name('ylyx').description('公司内部代码生成模板脚手架工具').version(pkg.version);
+
+program
+	.command('create')
+	.description('交互式创建代码（推荐）')
+	.action(async () => {
+		await interactiveCreate();
+	});
+
+program
+	.command('generate <template-name>')
+	.alias('g')
+	.description('使用指定模板生成代码')
+	.option('-o, --output <path>', '输出目录（默认：当前目录）', './')
+	.option('-n, --name <name>', '项目名称')
+	.action(async (templateName, options) => {
+		try {
+			let variables = {};
+
+			if (options.vars) {
+				try {
+					variables = JSON.parse(options.vars);
+				} catch (e) {
+					console.error('❌ 变量格式错误，请使用有效的JSON格式');
+					process.exit(1);
+				}
+			}
+
+			if (options.name) {
+				variables.projectName = options.name;
+				variables.name = options.name;
+			}
+
+			await generate(templateName, {
+				outputDir: options.output || './',
+				variables,
+			});
+		} catch (error) {
+			console.error('❌ 生成失败:', error.message);
+			process.exit(1);
+		}
+	});
+
+program
+	.command('list')
+	.alias('ls')
+	.description('列出所有可用模板')
+	.action(() => {
+		listTemplates();
+	});
+
+program
+	.command('info <template-name>')
+	.description('查看模板详情')
+	.action((templateName) => {
+		getTemplateInfo(templateName);
+	});
+
+program
+	.command('add <template-name> <template-path>')
+	.description('添加本地模板')
+	.action((templateName, templatePath) => {
+		addTemplate(templateName, templatePath);
+	});
+
+program
+	.command('install <repo-url>')
+	.alias('i')
+	.description('从 Git 仓库安装远程模板')
+	.option('-n, --name <name>', '模板名称（默认使用仓库名）')
+	.option('-b, --branch <branch>', '分支名称（默认: main）', 'main')
+	.action(async (repoUrl, options) => {
+		try {
+			const { installRemoteTemplate } = require('../lib/remote');
+			await installRemoteTemplate(repoUrl, options.branch, options.name);
+		} catch (error) {
+			console.error('❌ 安装失败:', error.message);
+			process.exit(1);
+		}
+	});
+
+program.parse(process.argv);
+
+// 如果没有提供任何命令，显示帮助信息
+if (!process.argv.slice(2).length) {
+	program.outputHelp();
+}

package/lib/generator.js

@@ -0,0 +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,
+};

package/lib/index.js

@@ -0,0 +1,113 @@
+const fs = require('fs-extra');
+const path = require('path');
+const inquirer = require('inquirer');
+const { getTemplateConfig } = require('./template');
+const { generateFiles } = require('./generator');
+const { getOutputDir, log } = require('./utils');
+
+/**
+ * 生成代码
+ */
+async function generate(templateName, options = {}) {
+	try {
+		// 获取模板配置
+		const templateConfig = getTemplateConfig(templateName);
+		const templatePath = templateConfig.path;
+
+		// 准备变量
+		let variables = { ...(options.variables || {}) };
+
+		// 如果模板定义了变量但用户没有提供，使用交互式收集
+		if (templateConfig.variables && Object.keys(templateConfig.variables).length > 0) {
+			const missingVars = Object.keys(templateConfig.variables).filter((key) => !(key in variables));
+
+			if (missingVars.length > 0) {
+				const prompts = missingVars.map((key) => {
+					const config = templateConfig.variables[key];
+					return {
+						type: config.type || 'input',
+						name: key,
+						message: config.message || `请输入 ${key}`,
+						default: config.default,
+						choices: config.choices,
+						validate: config.validate,
+					};
+				});
+
+				const answers = await inquirer.prompt(prompts);
+				variables = { ...variables, ...answers };
+			}
+		}
+
+		// 应用变量替换规则
+		if (templateConfig.replacements) {
+			Object.entries(templateConfig.replacements).forEach(([key, value]) => {
+				if (typeof value === 'string' && value.includes('{{')) {
+					// 使用 Handlebars 处理替换规则
+					const handlebars = require('handlebars');
+					const { registerHandlebarsHelpers } = require('./utils');
+					registerHandlebarsHelpers(handlebars);
+					const template = handlebars.compile(value, { noEscape: true });
+					variables[key] = template(variables);
+				} else {
+					variables[key] = value;
+				}
+			});
+		}
+
+		// 添加一些常用的辅助变量
+		if (variables.name) {
+			const { camelCase, pascalCase, kebabCase, snakeCase } = require('./utils');
+			variables.nameCamel = camelCase(variables.name);
+			variables.namePascal = pascalCase(variables.name);
+			variables.nameKebab = kebabCase(variables.name);
+			variables.nameSnake = snakeCase(variables.name);
+		}
+
+		// 为 React 组件添加 className 辅助变量
+		if (variables.componentName) {
+			const { pascalCase, kebabCase } = require('./utils');
+			const componentNameKebab = kebabCase(variables.componentName);
+			const useCSS = variables.useCSS || 'none';
+
+			// 根据样式方案生成 className 属性字符串（完整的 JSX 属性）
+			if (useCSS === 'modules') {
+				variables.classNameAttr = "className={`${styles.container} ${className || ''}`}";
+			} else if (useCSS === 'css') {
+				variables.classNameAttr = `className={\`${componentNameKebab} \${className || ''}\`}`;
+			} else {
+				variables.classNameAttr = 'className={className}';
+			}
+
+			// 生成导入语句
+			if (useCSS === 'modules') {
+				variables.cssImport = `import styles from './${componentNameKebab}.module.css';`;
+			} else if (useCSS === 'styled') {
+				variables.cssImport = "import styled from 'styled-components';";
+			} else if (useCSS === 'css') {
+				variables.cssImport = `import './${componentNameKebab}.css';`;
+			} else {
+				variables.cssImport = '';
+			}
+
+			variables.componentNamePascal = pascalCase(variables.componentName);
+			variables.componentNameKebab = componentNameKebab;
+		}
+
+		// 确定输出目录
+		const outputDir = getOutputDir(options.outputDir);
+		fs.ensureDirSync(outputDir);
+
+		// 生成文件
+		await generateFiles(templatePath, outputDir, variables, templateConfig);
+
+		log.success(`代码已生成到: ${outputDir}`);
+	} catch (error) {
+		log.error(`生成失败: ${error.message}`);
+		throw error;
+	}
+}
+
+module.exports = {
+	generate,
+};

package/lib/interactive.js

@@ -0,0 +1,87 @@
+const inquirer = require('inquirer');
+const { generate } = require('./index');
+const { listTemplates } = require('./template');
+const { log } = require('./utils');
+
+/**
+ * 交互式创建代码
+ */
+async function interactiveCreate() {
+	try {
+		// 获取模板列表（不打印）
+		const templates = listTemplates(false);
+
+		if (templates.length === 0) {
+			log.error('没有可用的模板');
+			return;
+		}
+
+		// 选择模板
+		const { templateName } = await inquirer.prompt([
+			{
+				type: 'list',
+				name: 'templateName',
+				message: '请选择模板',
+				choices: templates.map((t) => ({
+					name: `${t.name} - ${t.config.description || '无描述'}`,
+					value: t.name,
+				})),
+			},
+		]);
+
+		// 获取模板配置
+		const { getTemplateConfig } = require('./template');
+		const templateConfig = getTemplateConfig(templateName);
+
+		// 收集变量
+		const variables = {};
+
+		if (templateConfig.variables) {
+			const prompts = Object.entries(templateConfig.variables).map(([key, config]) => {
+				return {
+					type: config.type || 'input',
+					name: key,
+					message: config.message || `请输入 ${key}`,
+					default: config.default,
+					when:
+						config.when !== undefined
+							? (answers) => {
+									if (typeof config.when === 'function') {
+										return config.when(answers);
+									}
+									return config.when;
+							  }
+							: undefined,
+					choices: config.choices,
+					validate: config.validate,
+				};
+			});
+
+			const answers = await inquirer.prompt(prompts);
+			Object.assign(variables, answers);
+		}
+
+		// 询问输出目录
+		const { outputDir } = await inquirer.prompt([
+			{
+				type: 'input',
+				name: 'outputDir',
+				message: '输出目录',
+				default: './',
+			},
+		]);
+
+		// 生成代码
+		await generate(templateName, {
+			outputDir,
+			variables,
+		});
+	} catch (error) {
+		log.error(`创建失败: ${error.message}`);
+		process.exit(1);
+	}
+}
+
+module.exports = {
+	interactiveCreate,
+};