ylyx-cli 1.0.0 → 1.0.2

package/README.md

@@ -1,184 +1,226 @@
-# 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
+# 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
+```
+
+### 写入配置（mode）
+
+将当前目录的 `.ylyxrc.json` 写入/更新 `mode`（仅支持 `dev` / `prod`）：
+
+```bash
+ylyx config --mode dev
+# 或
+ylyx config prod
+```
+
+### 初始化配置（init config）
+
+初始化当前目录的配置文件与默认配置模板（会生成/补齐 `.ylyxrc.json`，并创建 `config/default-dev.js`、`config/default-prod.js` 等；默认不覆盖已有文件）：
+
+```bash
+ylyx init config
+
+# 指定初始模式
+ylyx init config --mode prod
+
+# 强制覆盖已存在文件
+ylyx init config --force
+```
+
+`init config` 还会尝试在当前目录的 `package.json` 中写入 npm 前置脚本（可在 `.ylyxrc.json` 的 `preScripts` 配置脚本名）：
+
+- 默认会写入 `predev` 和 `postbuild:prod`
+- 执行 `npm run dev` 前，会自动先执行 `ylyx config dev`（dev 使用 symlink 实时同步）
+- 执行 `npm run build:prod` 后，会自动执行 `ylyx config prod`（将 `default-prod.js` 复制到打包输出目录）
+
+prod 输出目录规则：
+
+- 优先使用 `.ylyxrc.json` 的 `buildDir`
+- 否则读取当前项目 `.env.production` 的 `VUE_APP_PUBLIC_URL`，默认写入 `<VUE_APP_PUBLIC_URL>/default.js`（会去掉首尾 `/`）
+
+## 云端模板
+
+模板可以放在 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
+{
+	"mode": "dev",
+	"publicDir": "./public",
+	"configDir": "./config",
+	"preScripts": {
+		"dev": "dev",
+		"prod": "build:prod"
+	},
+	"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

@@ -4,6 +4,7 @@ const { program } = require('commander');
 const { generate } = require('../lib/index');
 const { listTemplates, getTemplateInfo, addTemplate } = require('../lib/template');
 const { interactiveCreate } = require('../lib/interactive');
+const { setMode, initConfig } = require('../lib/config');
 const pkg = require('../package.json');
 
 program.name('ylyx').description('公司内部代码生成模板脚手架工具').version(pkg.version);
@@ -15,6 +16,44 @@ program
 		await interactiveCreate();
 	});
 
+program
+	.command('config [mode]')
+	.description('写入/更新 .ylyxrc.json 配置（目前支持：mode=dev|prod）')
+	.option('-m, --mode <mode>', '运行模式：dev | prod')
+	.option('--symlink', '切换 default.js 时强制使用 symlink（dev 默认）')
+	.option('--copy', '切换 default.js 时强制使用 copy')
+	.action((modeArg, options) => {
+		try {
+			const mode = options.mode || modeArg;
+			if (!mode) {
+				console.error('❌ 缺少参数：mode（dev|prod）');
+				console.error('示例：ylyx config --mode dev   或   ylyx config dev');
+				process.exit(1);
+			}
+			const method = options.copy ? 'copy' : options.symlink ? 'symlink' : undefined;
+			setMode(mode, { method });
+		} catch (error) {
+			console.error('❌ 配置失败:', error.message);
+			process.exit(1);
+		}
+	});
+
+program
+	.command('init')
+	.description('初始化相关资源')
+	.command('config')
+	.description('初始化配置（生成 .ylyxrc.json / config/default-*.js 等）')
+	.option('-m, --mode <mode>', '初始 mode：dev | prod（默认 dev）')
+	.option('-f, --force', '强制覆盖已存在文件')
+	.action((options) => {
+		try {
+			initConfig(options);
+		} catch (error) {
+			console.error('❌ 初始化配置失败:', error.message);
+			process.exit(1);
+		}
+	});
+
 program
 	.command('generate <template-name>')
 	.alias('g')

package/lib/config.js

@@ -0,0 +1,300 @@
+const path = require('path');
+const fs = require('fs-extra');
+const { log } = require('./utils');
+
+function getConfigPath() {
+	return path.join(process.cwd(), '.ylyxrc.json');
+}
+
+function normalizeMode(mode) {
+	if (typeof mode !== 'string') return null;
+	const m = mode.trim().toLowerCase();
+	if (m === 'dev' || m === 'prod') return m;
+	return null;
+}
+
+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 normalizePublicUrlToDir(publicUrl) {
+	if (!publicUrl || typeof publicUrl !== 'string') return '';
+	let v = publicUrl.trim();
+	v = v.replace(/\\/g, '/');
+	// ignore full urls
+	if (/^https?:\/\//i.test(v)) return '';
+	v = v.replace(/^\/+/, '').replace(/\/+$/, '');
+	return v;
+}
+
+function resolveProdBuildDir(config) {
+	// 1) 优先使用 .ylyxrc.json 的 buildDir（可为相对/绝对路径）
+	if (config.buildDir) {
+		return path.resolve(process.cwd(), config.buildDir);
+	}
+
+	// 2) 默认：读取 .env.production 的 VUE_APP_PUBLIC_URL，拼成 <publicUrlDir>
+	const envProdPath = path.join(process.cwd(), '.env.production');
+	const env = parseDotEnvFile(envProdPath);
+	const publicUrlDir = normalizePublicUrlToDir(env.VUE_APP_PUBLIC_URL);
+	if (publicUrlDir) {
+		return path.resolve(process.cwd(), publicUrlDir);
+	}
+	throw new Error(
+		'无法确定 prod 打包输出目录：请在 .ylyxrc.json 中配置 buildDir，或在 .env.production 中配置 VUE_APP_PUBLIC_URL'
+	);
+}
+
+function readConfigSafe(configPath) {
+	if (!fs.existsSync(configPath)) return {};
+	try {
+		return fs.readJsonSync(configPath);
+	} catch (e) {
+		throw new Error(`读取 .ylyxrc.json 失败，请确认它是有效 JSON：${e.message}`);
+	}
+}
+
+function writeIfAllowed(filePath, content, force) {
+	if (fs.existsSync(filePath) && !force) {
+		log.warn(`已存在，跳过：${path.relative(process.cwd(), filePath)}`);
+		return false;
+	}
+	fs.ensureDirSync(path.dirname(filePath));
+	fs.writeFileSync(filePath, content, 'utf-8');
+	log.success(`已写入：${path.relative(process.cwd(), filePath)}`);
+	return true;
+}
+
+function deriveDefaultVariantContent(baseContent, mode) {
+	const isDev = mode === 'dev';
+	const isProd = mode === 'prod';
+
+	let content = baseContent || '';
+	const devRe = /let\s+isDev\s*=\s*[^;]*;/;
+	const prodRe = /let\s+isProd\s*=\s*[^;]*;/;
+
+	if (devRe.test(content)) {
+		content = content.replace(devRe, `let isDev = ${isDev};`);
+	} else {
+		content = `let isDev = ${isDev};\n` + content;
+	}
+
+	if (prodRe.test(content)) {
+		content = content.replace(prodRe, `let isProd = ${isProd};`);
+	} else {
+		content = `let isProd = ${isProd};\n` + content;
+	}
+
+	return content;
+}
+
+function ensureSymlinkOrCopy({ src, dest, preferSymlink }) {
+	fs.ensureDirSync(path.dirname(dest));
+	if (!fs.existsSync(src)) {
+		log.warn(`未找到源文件：${path.relative(process.cwd(), src)}`);
+		return { ok: false, method: 'missing' };
+	}
+
+	// 如果目标已存在，先删除（不管是文件还是链接）
+	if (fs.existsSync(dest)) {
+		fs.removeSync(dest);
+	}
+
+	if (preferSymlink) {
+		try {
+			// Windows/macOS/Linux 都支持；Windows 可能因为权限失败，失败后回退 copy
+			fs.ensureSymlinkSync(src, dest, 'file');
+			return { ok: true, method: 'symlink' };
+		} catch (e) {
+			log.warn(`创建 symlink 失败，将降级为 copy：${e.message}`);
+		}
+	}
+
+	try {
+		fs.copyFileSync(src, dest);
+		return { ok: true, method: 'copy' };
+	} catch (e) {
+		log.error(`写入失败：${e.message}`);
+		return { ok: false, method: 'copy_failed' };
+	}
+}
+
+/**
+ * 写入/更新 .ylyxrc.json 的 mode 字段（dev|prod），并与已有配置合并
+ */
+function setMode(mode, options = {}) {
+	const normalized = normalizeMode(mode);
+	if (!normalized) {
+		throw new Error(`mode 取值只能是 dev 或 prod（当前: ${mode}）`);
+	}
+
+	const configPath = getConfigPath();
+	const config = readConfigSafe(configPath);
+
+	// 可选：如果当前项目目录存在 public/default-{mode}.js，则复制到 public/default.js
+	// 注意：切换应发生在“项目目录”(process.cwd())，而不是 CLI 自身的 lib 目录(__dirname)
+	// 优先从 .ylyxrc.json 中读取 publicDir，其次使用默认 ./public
+	const configDir = path.resolve(process.cwd(), config.configDir || 'config');
+	const publicDir = path.resolve(process.cwd(), config.publicDir || 'public');
+	const defaultVariant = path.join(configDir, `default-${normalized}.js`);
+	const defaultFile =
+		normalized === 'prod'
+			? path.join(resolveProdBuildDir(config), 'default.js')
+			: path.join(publicDir, 'default.js');
+
+	// 默认策略：dev 使用 symlink（实时同步），prod 使用 copy（稳定）
+	const method = options.method || (normalized === 'dev' ? 'symlink' : 'copy');
+	const result = ensureSymlinkOrCopy({
+		src: defaultVariant,
+		dest: defaultFile,
+		preferSymlink: method === 'symlink',
+	});
+
+	if (result.ok) {
+		const label = result.method === 'symlink' ? 'symlink' : 'copy';
+		log.success(
+			`已(${label})切换 ${path.relative(process.cwd(), defaultFile)} <- ${path.relative(
+				process.cwd(),
+				defaultVariant
+			)}`
+		);
+		if (normalized === 'dev' && result.method === 'symlink') {
+			log.info('dev 模式实时同步已启用：修改 default-dev.js 会立即反映到 default.js');
+		}
+	} else if (result.method === 'missing') {
+		log.warn(`未找到 ${path.relative(process.cwd(), defaultVariant)}，请先运行 ylyx init config`);
+	}
+
+	config.mode = normalized;
+	fs.writeJsonSync(configPath, config, { spaces: 2 });
+	log.success(`已写入配置：mode=${normalized}`);
+	log.info(`配置文件：${configPath}`);
+}
+
+/**
+ * init config：初始化配置目录与示例文件
+ * - 写入/补齐 .ylyxrc.json（mode/publicDir/configDir）
+ * - 生成 config/default-dev.js 与 config/default-prod.js（基于现有 public/default.js 派生）
+ * - 若 public/default.js 不存在，则按当前 mode 生成一份
+ */
+function initConfig(options = {}) {
+	const force = !!options.force;
+	const configPath = getConfigPath();
+	const existing = readConfigSafe(configPath);
+
+	const next = {
+		...existing,
+		mode: existing.mode || 'dev',
+		publicDir: existing.publicDir || './public',
+		configDir: existing.configDir || './config',
+		// npm scripts：默认对 dev 与 build:prod 增加前置脚本 pre<name>
+		// 可在 .ylyxrc.json 中改成你的项目脚本名（例如 dev=serve，prod=build）
+		preScripts: existing.preScripts || { dev: 'dev', prod: 'build:prod' },
+	};
+
+	if (options.mode) {
+		const normalized = normalizeMode(options.mode);
+		if (!normalized) throw new Error(`mode 取值只能是 dev 或 prod（当前: ${options.mode}）`);
+		next.mode = normalized;
+	}
+
+	fs.writeJsonSync(configPath, next, { spaces: 2 });
+	log.success(`已初始化配置文件：${path.relative(process.cwd(), configPath)}`);
+
+	const publicDirAbs = path.resolve(process.cwd(), next.publicDir || 'public');
+	const configDirAbs = path.resolve(process.cwd(), next.configDir || 'config');
+	fs.ensureDirSync(publicDirAbs);
+	fs.ensureDirSync(configDirAbs);
+
+	const publicDefault = path.join(publicDirAbs, 'default.js');
+	let baseContent = '';
+	if (fs.existsSync(publicDefault)) {
+		baseContent = fs.readFileSync(publicDefault, 'utf-8');
+	} else {
+		baseContent =
+			"// 自动生成的默认配置（请按项目需要补全）\n" +
+			"let isDev = true;\n" 
+	}
+
+	const devVariantPath = path.join(configDirAbs, 'default-dev.js');
+	const prodVariantPath = path.join(configDirAbs, 'default-prod.js');
+
+	writeIfAllowed(devVariantPath, deriveDefaultVariantContent(baseContent, 'dev'), force);
+	writeIfAllowed(prodVariantPath, deriveDefaultVariantContent(baseContent, 'prod'), force);
+
+	// 如果 public/default.js 不存在，则按当前 mode 生成一份
+	if (!fs.existsSync(publicDefault)) {
+		const src =
+			next.mode === 'prod'
+				? path.join(configDirAbs, 'default-prod.js')
+				: path.join(configDirAbs, 'default-dev.js');
+		if (fs.existsSync(src)) {
+			fs.copyFileSync(src, publicDefault);
+			log.success(
+				`已生成 ${path.relative(process.cwd(), publicDefault)} <- ${path.relative(process.cwd(), src)}`
+			);
+		}
+	} else {
+		log.info(`已存在：${path.relative(process.cwd(), publicDefault)}（未覆盖）`);
+	}
+
+	// 初始化 package.json 的 npm 前置脚本：pre<devScript> / pre<prodScript>
+	const packageJsonPath = path.join(process.cwd(), 'package.json');
+	if (!fs.existsSync(packageJsonPath)) {
+		log.warn('未找到 package.json，已跳过 npm 前置脚本初始化');
+		return;
+	}
+
+	let pkg = {};
+	try {
+		pkg = fs.readJsonSync(packageJsonPath);
+	} catch (e) {
+		throw new Error(`读取 package.json 失败，请确认它是有效 JSON：${e.message}`);
+	}
+
+	pkg.scripts = pkg.scripts || {};
+	const devTarget = (next.preScripts && next.preScripts.dev) || 'dev';
+	const prodTarget = (next.preScripts && next.preScripts.prod) || 'build:prod';
+
+	const desired = [
+		{ name: `pre${devTarget}`, value: 'ylyx config dev' },
+		{ name: `post${prodTarget}`, value: 'ylyx config prod' },
+	];
+
+	for (const item of desired) {
+		if (pkg.scripts[item.name] && !force) {
+			log.warn(`package.json scripts 已存在，跳过：${item.name}`);
+			continue;
+		}
+		pkg.scripts[item.name] = item.value;
+		log.success(`已写入 package.json scripts：${item.name}`);
+	}
+
+	fs.writeJsonSync(packageJsonPath, pkg, { spaces: 2 });
+	log.info(`package.json：${path.relative(process.cwd(), packageJsonPath)}`);
+}
+
+module.exports = {
+	setMode,
+	normalizeMode,
+	initConfig,
+};

package/package.json

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