ylyx-cli 1.0.0

package/lib/remote.js

@@ -0,0 +1,179 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { execSync } = require('child_process');
+const { log } = require('./utils');
+
+/**
+ * 获取模板缓存目录
+ */
+function getTemplateCacheDir() {
+	const os = require('os');
+	const cacheDir = path.join(os.homedir(), '.ylyx', 'templates-cache');
+	fs.ensureDirSync(cacheDir);
+	return cacheDir;
+}
+
+/**
+ * 解析 Git 仓库 URL
+ * 支持格式：
+ * - https://github.com/user/repo
+ * - https://github.com/user/repo.git
+ * - git@github.com:user/repo.git
+ * - user/repo (简写，默认 GitHub)
+ */
+function parseGitUrl(url) {
+	// 如果是简写格式 user/repo，转换为 GitHub URL
+	if (!url.includes('://') && !url.includes('@') && url.includes('/')) {
+		url = `https://github.com/${url}`;
+	}
+
+	// 如果不是 .git 结尾，添加 .git
+	if (!url.endsWith('.git')) {
+		url = url + '.git';
+	}
+
+	// 提取仓库信息
+	let match;
+	if (url.startsWith('https://')) {
+		match = url.match(/https:\/\/([^/]+)\/([^/]+)\/([^/]+)/);
+	} else if (url.startsWith('git@')) {
+		match = url.match(/git@([^:]+):([^/]+)\/([^/]+)/);
+	}
+
+	if (!match) {
+		throw new Error(`无法解析 Git URL: ${url}`);
+	}
+
+	const host = match[1];
+	const owner = match[2];
+	const repo = match[3].replace('.git', '');
+
+	return {
+		host,
+		owner,
+		repo,
+		url: url,
+		cacheKey: `${host}/${owner}/${repo}`,
+	};
+}
+
+/**
+ * 检查 Git 是否可用
+ */
+function checkGitAvailable() {
+	try {
+		execSync('git --version', { stdio: 'ignore' });
+		return true;
+	} catch (e) {
+		return false;
+	}
+}
+
+/**
+ * 从 Git 仓库下载模板
+ */
+async function downloadTemplateFromGit(repoUrl, branch = 'main') {
+	const gitInfo = parseGitUrl(repoUrl);
+	const cacheDir = getTemplateCacheDir();
+	const templateCachePath = path.join(cacheDir, gitInfo.cacheKey.replace(/\//g, '_'));
+
+	// 检查是否已经缓存
+	if (fs.existsSync(templateCachePath)) {
+		try {
+			// 更新缓存
+			const cwd = process.cwd();
+			try {
+				execSync('git fetch', { cwd: templateCachePath, stdio: 'ignore' });
+				execSync(`git checkout ${branch}`, { cwd: templateCachePath, stdio: 'ignore' });
+				execSync('git pull', { cwd: templateCachePath, stdio: 'ignore' });
+				log.info(`使用缓存的模板: ${gitInfo.cacheKey}`);
+				return templateCachePath;
+			} catch (e) {
+				// 如果更新失败，删除缓存重新下载
+				fs.removeSync(templateCachePath);
+			}
+		} catch (e) {
+			// 如果更新失败，删除缓存重新下载
+			fs.removeSync(templateCachePath);
+		}
+	}
+
+	// 检查 Git 是否可用
+	if (!checkGitAvailable()) {
+		throw new Error('Git 未安装或不在 PATH 中，请先安装 Git');
+	}
+
+	// 克隆仓库
+	try {
+		log.info(`正在下载模板: ${gitInfo.cacheKey}...`);
+		execSync(`git clone -b ${branch} --depth 1 ${gitInfo.url} "${templateCachePath}"`, {
+			stdio: 'pipe',
+		});
+		log.success(`模板下载成功: ${gitInfo.cacheKey}`);
+		return templateCachePath;
+	} catch (e) {
+		// 如果指定分支失败，尝试默认分支
+		if (branch !== 'main' && branch !== 'master') {
+			log.warn(`分支 ${branch} 不存在，尝试使用默认分支`);
+			if (fs.existsSync(templateCachePath)) {
+				fs.removeSync(templateCachePath);
+			}
+			try {
+				execSync(`git clone --depth 1 ${gitInfo.url} "${templateCachePath}"`, {
+					stdio: 'pipe',
+				});
+				return templateCachePath;
+			} catch (e2) {
+				throw new Error(`下载模板失败: ${e2.message}`);
+			}
+		}
+		throw new Error(`下载模板失败: ${e.message}`);
+	}
+}
+
+/**
+ * 安装远程模板到本地
+ */
+async function installRemoteTemplate(repoUrl, branch = 'main', templateName = null) {
+	const gitInfo = parseGitUrl(repoUrl);
+
+	// 如果没有指定模板名，使用仓库名
+	if (!templateName) {
+		templateName = gitInfo.repo;
+	}
+
+	// 下载模板
+	const downloadedPath = await downloadTemplateFromGit(repoUrl, branch);
+
+	// 检查是否有 template.json
+	const templateJsonPath = path.join(downloadedPath, 'template.json');
+	if (!fs.existsSync(templateJsonPath)) {
+		// 如果没有 template.json，检查是否有 files 目录
+		const filesDir = path.join(downloadedPath, 'files');
+		if (!fs.existsSync(filesDir)) {
+			throw new Error('模板格式不正确：缺少 template.json 或 files 目录');
+		}
+	}
+
+	// 复制到本地模板目录
+	const { getTemplatesDir } = require('./utils');
+	const templatesDir = getTemplatesDir();
+	const targetPath = path.join(templatesDir, templateName);
+
+	if (fs.existsSync(targetPath)) {
+		log.warn(`模板 ${templateName} 已存在，将被覆盖`);
+		fs.removeSync(targetPath);
+	}
+
+	fs.copySync(downloadedPath, targetPath);
+	log.success(`模板已安装: ${templateName}`);
+
+	return targetPath;
+}
+
+module.exports = {
+	downloadTemplateFromGit,
+	installRemoteTemplate,
+	parseGitUrl,
+	getTemplateCacheDir,
+};

package/lib/template.js

@@ -0,0 +1,174 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { getTemplatesDir, log } = require('./utils');
+
+/**
+ * 获取所有模板列表
+ */
+function listTemplates(shouldPrint = true) {
+	const templatesDir = getTemplatesDir();
+
+	if (!fs.existsSync(templatesDir)) {
+		if (shouldPrint) {
+			log.warn(`模板目录不存在: ${templatesDir}`);
+			log.info('请先创建 templates 目录并添加模板');
+		}
+		return [];
+	}
+
+	const items = fs.readdirSync(templatesDir, { withFileTypes: true });
+	const templates = items
+		.filter((item) => item.isDirectory())
+		.map((item) => {
+			const templatePath = path.join(templatesDir, item.name);
+			const configPath = path.join(templatePath, 'template.json');
+
+			let config = {};
+			if (fs.existsSync(configPath)) {
+				try {
+					config = fs.readJsonSync(configPath);
+				} catch (e) {
+					// 忽略配置读取错误
+				}
+			}
+
+			return {
+				name: item.name,
+				path: templatePath,
+				config,
+			};
+		});
+
+	if (shouldPrint) {
+		if (templates.length === 0) {
+			log.warn('暂无可用模板');
+			return [];
+		}
+
+		console.log('\n可用模板列表：\n');
+		templates.forEach((template, index) => {
+			const desc = template.config.description || '无描述';
+			const version = template.config.version || '1.0.0';
+			console.log(`  ${index + 1}. ${template.name} (v${version})`);
+			console.log(`     ${desc}\n`);
+		});
+	}
+
+	return templates;
+}
+
+/**
+ * 获取模板信息
+ */
+function getTemplateInfo(templateName) {
+	const templatesDir = getTemplatesDir();
+	const templatePath = path.join(templatesDir, templateName);
+
+	if (!fs.existsSync(templatePath)) {
+		log.error(`模板不存在: ${templateName}`);
+		return null;
+	}
+
+	const configPath = path.join(templatePath, 'template.json');
+	let config = {};
+
+	if (fs.existsSync(configPath)) {
+		try {
+			config = fs.readJsonSync(configPath);
+		} catch (e) {
+			log.error(`读取模板配置失败: ${e.message}`);
+			return null;
+		}
+	} else {
+		log.warn('模板配置文件不存在');
+	}
+
+	console.log(`\n模板信息: ${templateName}\n`);
+	console.log(`  名称: ${config.name || templateName}`);
+	console.log(`  版本: ${config.version || '1.0.0'}`);
+	console.log(`  描述: ${config.description || '无描述'}`);
+
+	if (config.variables && Object.keys(config.variables).length > 0) {
+		console.log(`\n  变量:`);
+		Object.entries(config.variables).forEach(([key, value]) => {
+			const type = value.type || 'string';
+			const desc = value.message || value.description || '';
+			const defaultValue = value.default !== undefined ? ` (默认: ${value.default})` : '';
+			console.log(`    - ${key} (${type})${defaultValue}: ${desc}`);
+		});
+	}
+
+	console.log('');
+	return config;
+}
+
+/**
+ * 获取模板配置
+ */
+function getTemplateConfig(templateName) {
+	const templatesDir = getTemplatesDir();
+	const templatePath = path.join(templatesDir, templateName);
+
+	if (!fs.existsSync(templatePath)) {
+		// 如果本地不存在，尝试检查是否是远程模板格式
+		// 格式: owner/repo 或完整的 Git URL
+		if (templateName.includes('/') || templateName.includes('://') || templateName.includes('@')) {
+			throw new Error(`模板不存在: ${templateName}\n提示: 使用 'ylyx install ${templateName}' 安装远程模板`);
+		}
+		throw new Error(`模板不存在: ${templateName}`);
+	}
+
+	const configPath = path.join(templatePath, 'template.json');
+	let config = {};
+
+	if (fs.existsSync(configPath)) {
+		try {
+			config = fs.readJsonSync(configPath);
+		} catch (e) {
+			throw new Error(`读取模板配置失败: ${e.message}`);
+		}
+	}
+
+	return {
+		...config,
+		path: templatePath,
+	};
+}
+
+/**
+ * 添加模板（复制模板目录）
+ */
+function addTemplate(templateName, sourcePath) {
+	const templatesDir = getTemplatesDir();
+	const targetPath = path.join(templatesDir, templateName);
+
+	// 确保模板目录存在
+	fs.ensureDirSync(templatesDir);
+
+	// 检查源路径是否存在
+	if (!fs.existsSync(sourcePath)) {
+		log.error(`源路径不存在: ${sourcePath}`);
+		return;
+	}
+
+	// 检查目标路径是否已存在
+	if (fs.existsSync(targetPath)) {
+		log.warn(`模板已存在: ${templateName}`);
+		log.info('如需更新，请先删除现有模板');
+		return;
+	}
+
+	try {
+		fs.copySync(sourcePath, targetPath);
+		log.success(`模板添加成功: ${templateName}`);
+	} catch (e) {
+		log.error(`添加模板失败: ${e.message}`);
+	}
+}
+
+module.exports = {
+	listTemplates,
+	getTemplateInfo,
+	getTemplateConfig,
+	addTemplate,
+};

package/lib/utils.js

@@ -0,0 +1,134 @@
+const path = require('path');
+const fs = require('fs-extra');
+const chalk = require('chalk');
+
+/**
+ * 转换为驼峰命名
+ */
+function camelCase(str) {
+	return str
+		.replace(/(?:^\w|[A-Z]|\b\w)/g, (word, index) => {
+			return index === 0 ? word.toLowerCase() : word.toUpperCase();
+		})
+		.replace(/\s+/g, '');
+}
+
+/**
+ * 转换为帕斯卡命名
+ */
+function pascalCase(str) {
+	return str
+		.replace(/(?:^\w|[A-Z]|\b\w)/g, (word) => {
+			return word.toUpperCase();
+		})
+		.replace(/\s+/g, '');
+}
+
+/**
+ * 转换为短横线命名
+ */
+function kebabCase(str) {
+	return str
+		.replace(/([a-z])([A-Z])/g, '$1-$2')
+		.replace(/[\s_]+/g, '-')
+		.toLowerCase();
+}
+
+/**
+ * 转换为下划线命名
+ */
+function snakeCase(str) {
+	return str
+		.replace(/([a-z])([A-Z])/g, '$1_$2')
+		.replace(/[\s-]+/g, '_')
+		.toLowerCase();
+}
+
+/**
+ * 获取模板目录路径
+ */
+function getTemplatesDir() {
+	const configPath = path.join(process.cwd(), '.ylyxrc.json');
+	if (fs.existsSync(configPath)) {
+		const config = fs.readJsonSync(configPath);
+		if (config.templatesDir) {
+			return path.resolve(process.cwd(), config.templatesDir);
+		}
+	}
+
+	// 默认使用项目内的 templates 目录
+	return path.join(__dirname, '../templates');
+}
+
+/**
+ * 获取输出目录
+ */
+function getOutputDir(customOutputDir) {
+	if (customOutputDir) {
+		return path.resolve(process.cwd(), customOutputDir);
+	}
+
+	const configPath = path.join(process.cwd(), '.ylyxrc.json');
+	if (fs.existsSync(configPath)) {
+		const config = fs.readJsonSync(configPath);
+		if (config.outputDir) {
+			return path.resolve(process.cwd(), config.outputDir);
+		}
+	}
+
+	return process.cwd();
+}
+
+/**
+ * 注册 Handlebars 辅助函数
+ */
+function registerHandlebarsHelpers(handlebars) {
+	handlebars.registerHelper('camelCase', (str) => {
+		return camelCase(str);
+	});
+
+	handlebars.registerHelper('pascalCase', (str) => {
+		return pascalCase(str);
+	});
+
+	handlebars.registerHelper('kebabCase', (str) => {
+		return kebabCase(str);
+	});
+
+	handlebars.registerHelper('snakeCase', (str) => {
+		return snakeCase(str);
+	});
+
+	handlebars.registerHelper('upperCase', (str) => {
+		return String(str).toUpperCase();
+	});
+
+	handlebars.registerHelper('lowerCase', (str) => {
+		return String(str).toLowerCase();
+	});
+
+	handlebars.registerHelper('eq', (a, b) => {
+		return a === b;
+	});
+}
+
+/**
+ * 日志输出
+ */
+const log = {
+	success: (msg) => console.log(chalk.green('✓'), msg),
+	error: (msg) => console.error(chalk.red('✗'), msg),
+	info: (msg) => console.log(chalk.blue('ℹ'), msg),
+	warn: (msg) => console.log(chalk.yellow('⚠'), msg),
+};
+
+module.exports = {
+	camelCase,
+	pascalCase,
+	kebabCase,
+	snakeCase,
+	getTemplatesDir,
+	getOutputDir,
+	registerHandlebarsHelpers,
+	log,
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+    "name": "ylyx-cli",
+    "version": "1.0.0",
+    "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": {
+        "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"
+    },
+    "devDependencies": {
+        "@types/node": "^20.10.0"
+    }
+}

package/templates/react-app/files/README.md

@@ -0,0 +1,23 @@
+# 1
+
+这是一个使用 YLYX CLI 生成的 React 项目。
+
+## 开始使用
+
+### 安装依赖
+
+\`\`\`bash
+npm install
+\`\`\`
+
+### 启动开发服务器
+
+\`\`\`bash
+npm start
+\`\`\`
+
+### 构建生产版本
+
+\`\`\`bash
+npm run build
+\`\`\`

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

@@ -0,0 +1,29 @@
+{
+    "name": "1",
+    "version": "1.0.0",
+    "description": "",
+    "main": "index.js",
+    "scripts": {
+        "start": "react-scripts start",
+        "build": "react-scripts build",
+        "test": "react-scripts test",
+        "eject": "react-scripts eject"
+    },
+    "dependencies": {
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0",
+        "react-scripts": "5.0.1"
+    },
+    "browserslist": {
+        "production": [
+            ">0.2%",
+            "not dead",
+            "not op_mini all"
+        ],
+        "development": [
+            "last 1 chrome version",
+            "last 1 firefox version",
+            "last 1 safari version"
+        ]
+    }
+}

package/templates/react-app/files/public/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="zh-CN">
+	<head>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<title>1</title>
+	</head>
+	<body>
+		<div id="root"></div>
+	</body>
+</html>

package/templates/react-app/files/src/App.css

@@ -0,0 +1,15 @@
+.App {
+	text-align: center;
+}
+
+.App-header {
+	background-color: #282c34;
+	padding: 20px;
+	color: white;
+	min-height: 100vh;
+	display: flex;
+	flex-direction: column;
+	align-items: center;
+	justify-content: center;
+	font-size: calc(10px + 2vmin);
+}

package/templates/react-app/files/src/App.js

@@ -0,0 +1,15 @@
+import React from 'react';
+import './App.css';
+
+function App() {
+	return (
+		<div className="App">
+			<header className="App-header">
+				<h1>欢迎使用 1</h1>
+				<p>这是一个 React 项目模板</p>
+			</header>
+		</div>
+	);
+}
+
+export default App;

package/templates/react-app/files/src/index.css

@@ -0,0 +1,10 @@
+body {
+	margin: 0;
+	font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
+	-webkit-font-smoothing: antialiased;
+	-moz-osx-font-smoothing: grayscale;
+}
+
+code {
+	font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', monospace;
+}

package/templates/react-app/files/src/index.js

@@ -0,0 +1,11 @@
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import './index.css';
+import App from './App';
+
+const root = ReactDOM.createRoot(document.getElementById('root'));
+root.render(
+	<React.StrictMode>
+		<App />
+	</React.StrictMode>
+);

package/templates/react-app/template.json

@@ -0,0 +1,12 @@
+{
+    "name": "react-app",
+    "description": "React 项目初始模板",
+    "version": "1.0.0",
+    "variables": {
+        "projectName": {
+            "type": "input",
+            "message": "请输入项目名称",
+            "default": "my-react-app"
+        }
+    }
+}

package/templates/react-component/files/Component.module.css

@@ -0,0 +1,5 @@
+.container {
+  display: flex;
+  flex-direction: column;
+}
+