flu-cli 0.0.4 → 2.0.0

package/lib/templates/templateCopier.js

@@ -0,0 +1,296 @@
+/**
+ * 模板复制器
+ * 职责：复制内置/自定义模板至目标目录，并执行变量替换与文件筛选
+ * 特性：保留平台工程与包名、支持 .template 文件落地、清理模板特有文件
+ */
+
+import fsExtra from 'fs-extra';
+import { join } from 'path';
+import { readFileSync, writeFileSync, readdirSync, statSync, existsSync } from 'fs';
+import { logger } from '../utils/logger.js';
+
+const { copySync, removeSync } = fsExtra;
+
+/**
+ * 复制模板到目标目录
+ * @param {string} templatePath - 模板路径
+ * @param {string} targetPath - 目标路径
+ * @returns {Promise<boolean>} 是否成功
+ */
+export async function copyTemplate (templatePath, targetPath) {
+  try {
+    // 检查模板路径是否存在
+    if (!existsSync(templatePath)) {
+      logger.error(`模板路径不存在: ${templatePath}`);
+      return false;
+    }
+
+    // 需要排除的文件和目录
+    const excludes = [
+      '.git',
+      '.github',
+      'node_modules',
+      '.flu-cli.yaml',
+      'README.template.md',
+      '.DS_Store',
+      'pubspec.yaml'  // 排除本地调试用的 pubspec.yaml
+    ];
+
+    // 复制文件，排除特定文件
+    copySync(templatePath, targetPath, {
+      filter: (src) => {
+        const basename = src.split('/').pop();
+        return !excludes.includes(basename);
+      },
+      overwrite: true
+    });
+
+    // 处理 pubspec.yaml.template -> pubspec.yaml
+    const templatePubspec = join(templatePath, 'pubspec.yaml.template');
+    const targetPubspec = join(targetPath, 'pubspec.yaml');
+    if (existsSync(templatePubspec)) {
+      // 复制 .template 文件并覆盖 Flutter 生成的 pubspec.yaml
+      copySync(templatePubspec, targetPubspec, { overwrite: true });
+      logger.info('已使用模板的 pubspec.yaml.template');
+    } else {
+      logger.warn('未找到 pubspec.yaml.template，使用 Flutter 默认配置');
+    }
+
+    return true;
+
+  } catch (error) {
+    logger.error(`复制模板失败: ${error.message}`);
+    return false;
+  }
+}
+
+// 仅复制自定义模板中的通用代码与配置，保留目标工程的平台与包名
+export async function copyCustomTemplate (templatePath, targetPath) {
+  try {
+    if (!existsSync(templatePath)) {
+      logger.error(`模板路径不存在: ${templatePath}`);
+      return false;
+    }
+
+    const includeDirs = ['lib', 'assets', '.vscode'];
+    const includeFiles = ['analysis_options.yaml', 'README.md', 'pubspec.yaml'];
+
+    for (const dir of includeDirs) {
+      const srcDir = join(templatePath, dir);
+      const dstDir = join(targetPath, dir);
+      if (existsSync(srcDir)) {
+        copySync(srcDir, dstDir, { overwrite: true });
+      }
+    }
+
+    for (const file of includeFiles) {
+      const srcFile = join(templatePath, file);
+      const dstFile = join(targetPath, file);
+      if (existsSync(srcFile)) {
+        copySync(srcFile, dstFile, { overwrite: true });
+      }
+    }
+
+    return true;
+  } catch (error) {
+    logger.error(`复制自定义模板失败: ${error.message}`);
+    return false;
+  }
+}
+
+/**
+ * 使用模板的 pubspec.yaml 合并覆盖目标项目（仅修改 name 保持项目名）
+ */
+export function mergePubspecFromTemplate (templatePath, projectDir, projectName) {
+  try {
+    const tplPub = join(templatePath, 'pubspec.yaml');
+    const dstPub = join(projectDir, 'pubspec.yaml');
+    if (!existsSync(tplPub) || !existsSync(dstPub)) return;
+    let content = readFileSync(tplPub, 'utf8');
+    if (/^name:\s+/m.test(content)) {
+      content = content.replace(/^name:\s+.*/m, `name: ${projectName}`);
+    } else {
+      content = `name: ${projectName}\n` + content;
+    }
+    writeFileSync(dstPub, content, 'utf8');
+  } catch (error) {
+    // 忽略错误
+  }
+}
+
+/**
+ * 替换文件中的变量
+ * @param {string} projectDir - 项目目录
+ * @param {object} variables - 变量对象
+ */
+export async function replaceVariables (projectDir, variables) {
+  try {
+    // 需要替换变量的文件模式
+    const patterns = [
+      '**/*.dart',
+      'pubspec.yaml',
+      'README.md',
+      'android/app/build.gradle',
+      'ios/Runner/Info.plist'
+    ];
+
+    // 变量映射
+    const replacements = {
+      '{{projectName}}': variables.projectName,
+      '{{project_name}}': variables.projectName,
+      '{{package_name}}': variables.packageName,
+      '{{author}}': variables.author || 'Your Name',
+      '{{year}}': new Date().getFullYear().toString()
+    };
+
+    // 递归替换目录中的文件
+    replaceInDirectory(projectDir, replacements);
+
+    // 修复 test 文件中的导入路径
+    fixTestFile(projectDir, variables.projectName);
+
+    return true;
+
+  } catch (error) {
+    logger.error(`替换变量失败: ${error.message}`);
+    return false;
+  }
+}
+
+/**
+ * 递归替换目录中的文件内容
+ */
+function replaceInDirectory (dir, replacements) {
+  const files = readdirSync(dir);
+
+  files.forEach(file => {
+    const filePath = join(dir, file);
+    const stat = statSync(filePath);
+
+    if (stat.isDirectory()) {
+      // 跳过特定目录
+      if (['.git', 'node_modules', '.dart_tool', 'build'].includes(file)) {
+        return;
+      }
+      replaceInDirectory(filePath, replacements);
+    } else if (stat.isFile()) {
+      // 只处理文本文件
+      if (isTextFile(filePath)) {
+        replaceInFile(filePath, replacements);
+      }
+    }
+  });
+}
+
+/**
+ * 替换单个文件中的内容
+ */
+function replaceInFile (filePath, replacements) {
+  try {
+    let content = readFileSync(filePath, 'utf8');
+    let modified = false;
+
+    // 执行所有替换
+    Object.entries(replacements).forEach(([pattern, value]) => {
+      if (content.includes(pattern)) {
+        content = content.replace(new RegExp(pattern, 'g'), value);
+        modified = true;
+      }
+    });
+
+    // 如果有修改，写回文件
+    if (modified) {
+      writeFileSync(filePath, content, 'utf8');
+    }
+
+  } catch (error) {
+    // 忽略二进制文件等错误
+  }
+}
+
+/**
+ * 判断是否为文本文件
+ */
+function isTextFile (filePath) {
+  const textExtensions = [
+    '.dart', '.yaml', '.yml', '.json', '.md', '.txt',
+    '.gradle', '.xml', '.plist', '.swift', '.kt', '.java',
+    '.js', '.ts', '.html', '.css', '.sh'
+  ];
+
+  return textExtensions.some(ext => filePath.endsWith(ext));
+}
+
+/**
+ * 修复 test 文件中的导入路径
+ */
+function fixTestFile (projectDir, projectName) {
+  const testFile = join(projectDir, 'test', 'widget_test.dart');
+
+  if (existsSync(testFile)) {
+    try {
+      let content = readFileSync(testFile, 'utf8');
+
+      // 替换导入路径：从 main.dart 改为 app.dart
+      content = content.replace(
+        `import 'package:${projectName}/main.dart';`,
+        `import 'package:${projectName}/app.dart';`
+      );
+
+      // 如果测试内容还是默认的计数器测试，可以注释掉或删除
+      if (content.includes('Counter increments smoke test')) {
+        content = `import 'package:flutter_test/flutter_test.dart';
+import 'package:${projectName}/app.dart';
+
+void main() {
+  testWidgets('App smoke test', (WidgetTester tester) async {
+    await tester.pumpWidget(const App());
+    expect(find.byType(App), findsOneWidget);
+  });
+}
+`;
+      }
+
+      writeFileSync(testFile, content, 'utf8');
+    } catch (error) {
+      // 忽略错误
+    }
+  }
+}
+
+/**
+ * 强制校正 pubspec.yaml 的 name 字段为项目名
+ */
+export function ensurePubspecName (projectDir, projectName) {
+  try {
+    const pubspec = join(projectDir, 'pubspec.yaml');
+    if (!existsSync(pubspec)) return;
+    let content = readFileSync(pubspec, 'utf8');
+    if (/^name:\s+/m.test(content)) {
+      content = content.replace(/^name:\s+.*/m, `name: ${projectName}`);
+    } else {
+      content = `name: ${projectName}\n` + content;
+    }
+    writeFileSync(pubspec, content, 'utf8');
+  } catch (error) {
+    // 忽略错误
+  }
+}
+
+/**
+ * 清理模板特有文件
+ */
+export function cleanupTemplateFiles (projectDir) {
+  const filesToRemove = [
+    '.flu-cli.yaml',
+    'README.template.md',
+    '.git'
+  ];
+
+  filesToRemove.forEach(file => {
+    const filePath = join(projectDir, file);
+    if (existsSync(filePath)) {
+      removeSync(filePath);
+    }
+  });
+}

package/lib/templates/templateManager.js

@@ -0,0 +1,191 @@
+/**
+ * 模板管理器
+ * 负责克隆、更新和管理模板缓存
+ */
+
+import simpleGit from 'simple-git';
+import { join, dirname } from 'path';
+import { existsSync, mkdirSync } from 'fs';
+import { homedir } from 'os';
+import { fileURLToPath } from 'url';
+import fsExtra from 'fs-extra';
+import { logger } from '../utils/logger.js';
+import { getConfig } from '../../config/dev.config.js';
+
+const { copySync, emptyDirSync } = fsExtra;
+
+// 获取当前文件所在目录
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// 模板缓存目录
+const CACHE_DIR = join(homedir(), '.flu-cli', 'templates');
+
+// 本地模板目录（用于开发测试）
+const LOCAL_TEMPLATES_DIR = join(__dirname, '..', '..', 'templates');
+
+/**
+ * 确保缓存目录存在
+ */
+function ensureCacheDir () {
+  if (!existsSync(CACHE_DIR)) {
+    mkdirSync(CACHE_DIR, { recursive: true });
+  }
+}
+
+/**
+ * 获取模板缓存路径
+ */
+export function getTemplateCachePath (templateName) {
+  return join(CACHE_DIR, templateName);
+}
+
+/**
+ * 克隆或更新模板
+ * @param {string} templateName - 模板名称
+ * @param {string} repoUrl - Git 仓库地址（可选，本地模板不需要）
+ * @param {string} branch - 分支名称
+ * @param {boolean} forceUpdate - 是否强制更新
+ * @param {boolean} isLocal - 是否为本地模板
+ * @param {string} sourceLocalPath - 自定义本地模板路径
+ * @returns {Promise<string>} 模板路径
+ */
+export async function cloneOrUpdateTemplate (templateName, repoUrl, branch = 'main', forceUpdate = false, isLocal = false, sourceLocalPath = null) {
+  try {
+    ensureCacheDir();
+
+    const templatePath = getTemplateCachePath(templateName);
+    const localTemplatePath = sourceLocalPath || join(LOCAL_TEMPLATES_DIR, templateName);
+
+    // 优先级判断：
+    // 1. 如果明确指定 isLocal=false 且有 repoUrl，使用远程
+    // 2. 如果本地模板存在且 isLocal=true，使用本地
+    // 3. 如果本地模板不存在但有 repoUrl，使用远程
+    // 4. 否则报错
+
+    const shouldUseLocal = isLocal && existsSync(localTemplatePath);
+    const shouldUseRemote = repoUrl && (!isLocal || !existsSync(localTemplatePath));
+
+    // 使用本地模板
+    if (shouldUseLocal) {
+      logger.info(`使用本地模板: ${templateName}`);
+
+      // 如果缓存不存在或需要强制更新，复制本地模板到缓存
+      if (!existsSync(templatePath) || forceUpdate) {
+        if (existsSync(templatePath)) {
+          emptyDirSync(templatePath);
+        }
+        copySync(localTemplatePath, templatePath, { overwrite: true });
+      } else {
+        logger.info(`使用缓存的本地模板`);
+      }
+
+      return templatePath;
+    }
+
+    // 使用远程 Git 模板
+    if (shouldUseRemote) {
+      logger.info(`使用远程模板: ${templateName}`);
+
+      const git = simpleGit();
+
+      // 如果模板已存在
+      if (existsSync(templatePath)) {
+        if (forceUpdate) {
+          const templateGit = simpleGit(templatePath);
+          await templateGit.fetch();
+          await templateGit.reset(['--hard', `origin/${branch}`]);
+          await templateGit.clean('f', ['-d', '-x']);
+        } else {
+          logger.info(`使用缓存的远程模板`);
+        }
+
+        return templatePath;
+      }
+
+      // 克隆新模板
+      logger.info(`从 Gitee 克隆模板 ${templateName}...`);
+      try {
+        await git.clone(repoUrl, templatePath, ['--branch', branch, '--single-branch', '--depth', '1']);
+        logger.success(`模板 ${templateName} 克隆成功`);
+      } catch (cloneError) {
+        logger.error(`克隆模板失败: ${cloneError.message}`);
+        logger.warn('可能的原因：');
+        logger.warn('  1. 网络连接问题');
+        logger.warn('  2. 仓库不存在或无访问权限');
+        logger.warn('  3. Git 未安装或配置错误');
+        logger.info('提示：可以使用 --remote 选项尝试从远程下载');
+        return null;
+      }
+
+      return templatePath;
+    }
+
+    // 无法获取模板
+    logger.error(`无法获取模板 ${templateName}: 本地模板不存在且未提供远程仓库地址`);
+    return null;
+
+  } catch (error) {
+    logger.error(`模板操作失败: ${error.message}`);
+    return null;
+  }
+}
+
+/**
+ * 检查模板是否有更新
+ */
+export async function checkTemplateUpdate (templateName) {
+  try {
+    const templatePath = getTemplateCachePath(templateName);
+
+    if (!existsSync(templatePath)) {
+      return { hasUpdate: false, message: '模板未缓存' };
+    }
+
+    const git = simpleGit(templatePath);
+
+    // 获取本地和远程的最新提交
+    await git.fetch();
+    const status = await git.status();
+
+    if (status.behind > 0) {
+      return {
+        hasUpdate: true,
+        message: `有 ${status.behind} 个新提交`,
+        behind: status.behind
+      };
+    }
+
+    return { hasUpdate: false, message: '已是最新版本' };
+
+  } catch (error) {
+    logger.error(`检查更新失败: ${error.message}`);
+    return { hasUpdate: false, message: '检查失败' };
+  }
+}
+
+/**
+ * 获取模板信息
+ */
+export async function getTemplateInfo (templateName) {
+  try {
+    const templatePath = getTemplateCachePath(templateName);
+
+    if (!existsSync(templatePath)) {
+      return null;
+    }
+
+    const git = simpleGit(templatePath);
+    const log = await git.log({ maxCount: 1 });
+
+    return {
+      path: templatePath,
+      lastCommit: log.latest,
+      exists: true
+    };
+
+  } catch (error) {
+    logger.error(`获取模板信息失败: ${error.message}`);
+    return null;
+  }
+}

package/lib/utils/config.js

@@ -0,0 +1,99 @@
+/**
+ * 配置管理 - 缓存用户设置
+ */
+
+import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'fs';
+import { join, dirname } from 'path';
+import { homedir } from 'os';
+
+const CONFIG_DIR = join(homedir(), '.flu-cli');
+const CONFIG_FILE = join(CONFIG_DIR, 'config.json');
+
+/**
+ * 读取配置
+ */
+export function getConfig () {
+  try {
+    if (existsSync(CONFIG_FILE)) {
+      const data = readFileSync(CONFIG_FILE, 'utf8');
+      return JSON.parse(data);
+    }
+  } catch (error) {
+    // 忽略错误，返回默认配置
+  }
+  return {};
+}
+
+/**
+ * 保存配置
+ */
+export function saveConfig (config) {
+  try {
+    // 确保目录存在
+    if (!existsSync(CONFIG_DIR)) {
+      mkdirSync(CONFIG_DIR, { recursive: true });
+    }
+    writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2), 'utf8');
+  } catch (error) {
+    // 忽略错误
+  }
+}
+
+/**
+ * 获取作者名字
+ */
+export function getAuthorName () {
+  const config = getConfig();
+  return config.authorName || 'Your Name';
+}
+
+/**
+ * 保存作者名字
+ */
+export function saveAuthorName (name) {
+  const config = getConfig();
+  config.authorName = name;
+  saveConfig(config);
+}
+
+// 读取默认模板（builtin/custom）
+export function getDefaultTemplate () {
+  const config = getConfig();
+  return config.defaultTemplate || { type: 'builtin', idOrName: 'lite' };
+}
+
+// 保存默认模板（builtin/custom）
+export function saveDefaultTemplate (defaultTemplate) {
+  const config = getConfig();
+  config.defaultTemplate = defaultTemplate;
+  saveConfig(config);
+}
+
+// 获取自定义模板列表
+export function getCustomTemplates () {
+  const config = getConfig();
+  return Array.isArray(config.customTemplates) ? config.customTemplates : [];
+}
+
+// 根据 id 查找自定义模板
+export function findCustomTemplateById (id) {
+  const list = getCustomTemplates();
+  return list.find(t => t.id === id) || null;
+}
+
+// 新增或更新自定义模板
+export function addOrUpdateCustomTemplate (tpl) {
+  const config = getConfig();
+  const list = Array.isArray(config.customTemplates) ? config.customTemplates : [];
+  const idx = list.findIndex(x => x.id === tpl.id);
+  if (idx >= 0) {
+    list[idx] = { ...list[idx], ...tpl };
+  } else {
+    list.push(tpl);
+  }
+  config.customTemplates = list;
+  // 顺带更新最后使用时间
+  tpl.lastUsedAt = Date.now();
+  saveConfig(config);
+  return tpl;
+}

package/lib/utils/flutterHelper.js

@@ -0,0 +1,85 @@
+/**
+ * Flutter 辅助工具
+ * 职责：封装 flutter create/pub get/版本检测等命令调用
+ */
+
+import { exec } from 'child_process';
+import { promisify } from 'util';
+import { logger } from './logger.js';
+
+const execAsync = promisify(exec);
+
+/**
+ * 运行 flutter create 命令
+ * @param {string} projectDir - 项目目录
+ * @param {string} projectName - 项目名称
+ * @param {string} packageName - 包名
+ * @returns {Promise<boolean>} 是否成功
+ */
+export async function runFlutterCreate (projectDir, projectName, packageName) {
+  try {
+    const command = `flutter create --project-name ${projectName} --org ${packageName} ${projectDir}`;
+
+    const { stdout, stderr } = await execAsync(command);
+
+    if (stderr && !stderr.includes('Warning')) {
+      logger.warn(stderr);
+    }
+
+    return stdout.includes('All done!') || stdout.includes('Created project');
+
+  } catch (error) {
+    logger.error(`Flutter create 失败: ${error.message}`);
+    return false;
+  }
+}
+
+/**
+ * 运行 flutter pub get
+ * @param {string} projectDir - 项目目录
+ * @returns {Promise<boolean>} 是否成功
+ */
+export async function runFlutterPubGet (projectDir) {
+  try {
+    const { stdout, stderr } = await execAsync('flutter pub get', {
+      cwd: projectDir
+    });
+
+    if (stderr) {
+      logger.warn(stderr);
+    }
+
+    return true;
+
+  } catch (error) {
+    logger.error(`Flutter pub get 失败: ${error.message}`);
+    return false;
+  }
+}
+
+/**
+ * 检查 Flutter 是否安装
+ * @returns {Promise<boolean>} 是否已安装
+ */
+export async function checkFlutterInstalled () {
+  try {
+    await execAsync('flutter --version');
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+/**
+ * 获取 Flutter 版本
+ * @returns {Promise<string|null>} Flutter 版本
+ */
+export async function getFlutterVersion () {
+  try {
+    const { stdout } = await execAsync('flutter --version');
+    const match = stdout.match(/Flutter (\d+\.\d+\.\d+)/);
+    return match ? match[1] : null;
+  } catch (error) {
+    return null;
+  }
+}