flu-cli 0.0.5 → 2.0.1

package/lib/generators/page_generator.js

@@ -0,0 +1,322 @@
+/**
+ * 页面生成器
+ */
+
+import { existsSync, mkdirSync, writeFileSync } from 'fs';
+import { join, relative, dirname } from 'path';
+import { logger } from '../utils/logger.js';
+import { toPascalCase, toSnakeCase, toTitleCase } from '../utils/string_helper.js';
+import { updateIndexFile } from '../utils/index_updater.js';
+import { detectProjectTemplate, getPagePath, getViewModelPath } from '../utils/project_detector.js';
+import { getSnippetContent } from '../utils/snippet_loader.js';
+import { generateModel } from './model_generator.js';
+
+/**
+ * 生成页面文件
+ */
+export function generatePage (name, options = {}) {
+  try {
+    const {
+      feature = null,
+      stateful = false,
+      stateless = false,
+      withViewModel = true,
+      isListPage = false,
+      outputDir = process.cwd()
+    } = options;
+
+    // 检测项目模板类型
+    const template = detectProjectTemplate(outputDir);
+    logger.info(`检测到项目类型: ${template || '未知'}`);
+
+    // 转换命名
+    const namePascal = toPascalCase(name);
+    const nameSnake = toSnakeCase(name);
+    const nameTitle = toTitleCase(name);
+
+    // 确定模块名称
+    let moduleName = feature || name;
+
+    // 根据模板类型确定输出路径
+    const pagesDir = getPagePath(outputDir, moduleName);
+
+    // 创建目录
+    if (!existsSync(pagesDir)) {
+      mkdirSync(pagesDir, { recursive: true });
+    }
+
+    // 获取 ViewModel 路径用于计算相对导入
+    const vmDir = getViewModelPath(outputDir, moduleName);
+    const pageFilePath = join(pagesDir, `${nameSnake}_page.dart`);
+    const vmFilePath = join(vmDir, `${nameSnake}_viewmodel.dart`);
+
+    // 计算相对导入路径
+    const vmImportPath = calculateRelativeImport(pageFilePath, vmFilePath);
+
+    // 生成文件内容（优先使用项目片段）
+    const variables = {
+      Name: namePascal,
+      name: nameSnake.replace(/_([a-z])/g, (_, c) => c.toUpperCase()),
+      snake_name: nameSnake,
+      title: nameTitle,
+      vm_import: withViewModel ? vmImportPath : '',
+      ModelName: namePascal + 'Model' // 默认 Model 名称
+    };
+
+    // 智能选择片段:
+    let content = null;
+    let key;
+
+    if (isListPage) {
+      // 列表页
+      key = 'flu.listPage';
+      logger.info('生成类型: ListPage (BaseListPage) + ViewModel');
+    } else if (stateless) {
+      // 强制使用 StatelessWidget
+      key = 'flu.lessPage';
+      if (withViewModel) {
+        logger.warn('⚠️  警告: 使用 StatelessWidget + ViewModel 组合,无法监听状态变化');
+      }
+      logger.info('生成类型: StatelessWidget (强制)');
+    } else if (stateful) {
+      // 明确指定 StatefulWidget
+      key = 'flu.stPage';
+      logger.info(`生成类型: StatefulWidget${withViewModel ? ' (BasePage) + ViewModel' : ''}`);
+    } else if (withViewModel) {
+      // 有 ViewModel 时,默认使用 StatefulWidget (BasePage)
+      key = 'flu.stPage';
+      logger.info('生成类型: StatefulWidget (BasePage) + ViewModel');
+    } else {
+      // 无 ViewModel 且未指定,默认 Stateless
+      key = 'flu.lessPage';
+      logger.info('生成类型: StatelessWidget (无 ViewModel)');
+    }
+
+    content = getSnippetContent(outputDir, key, variables);
+
+    if (!content) {
+      // 如果没有片段，使用默认生成逻辑 (这里简化处理，列表页必须有片段)
+      if (isListPage) {
+        logger.error('❌ 错误: 找不到列表页代码片段 (flu.listPage)');
+        logger.info('提示: 请运行 flu-cli sync-snippets 更新代码片段');
+        return false;
+      }
+      content = generatePageContent(namePascal, nameSnake, nameTitle, {
+        stateful,
+        withViewModel,
+        vmImportPath,
+        template
+      });
+    }
+
+    // 写入文件
+    if (existsSync(pageFilePath)) {
+      logger.error(`文件已存在: ${pageFilePath}`);
+      return false;
+    }
+
+    writeFileSync(pageFilePath, content, 'utf8');
+    logger.success(`页面创建成功: ${pageFilePath}`);
+
+    // 更新 index.dart
+    updateIndexFile(pagesDir, `${nameSnake}_page.dart`);
+
+    // 如果是列表页，先生成 Model
+    if (isListPage) {
+      logger.info('列表页需要 Model，正在自动生成...');
+      // 只有 modular/clean 架构才使用 feature
+      const modelFeature = (template === 'modular' || template === 'clean') ? moduleName : null;
+      generateModel(name, { feature: modelFeature, outputDir });
+    }
+
+    // 如果需要 ViewModel，也生成它
+    if (withViewModel) {
+      generateViewModel(name, { feature: moduleName, outputDir, template, isListPage });
+    }
+
+    return true;
+
+  } catch (error) {
+    logger.error(`生成页面失败: ${error.message}`);
+    return false;
+  }
+}
+
+/**
+ * 计算相对导入路径
+ */
+function calculateRelativeImport (fromFile, toFile) {
+  const fromDir = dirname(fromFile);
+  const relPath = relative(fromDir, toFile);
+  return relPath.replace(/\\/g, '/');
+}
+
+/**
+ * 生成页面内容
+ */
+function generatePageContent (namePascal, nameSnake, nameTitle, options) {
+  const { stateful, withViewModel, vmImportPath, template } = options;
+
+  let imports = `import 'package:flutter/material.dart';\n`;
+
+  // StatefulWidget with BasePage
+  if (stateful && withViewModel) {
+    // 导入 BasePage
+    const baseImport = template === 'lite'
+      ? '../base/base_page.dart'
+      : '../../core/base/base_page.dart';
+
+    imports += `import '${baseImport}';\n`;
+    imports += `import '${vmImportPath}';\n`;
+
+    return `${imports}
+class ${namePascal}Page extends BasePage<${namePascal}ViewModel> {
+  const ${namePascal}Page({super.key});
+
+  @override
+  State<${namePascal}Page> createState() => _${namePascal}PageState();
+}
+
+class _${namePascal}PageState extends BasePageState<${namePascal}ViewModel, ${namePascal}Page> {
+  // ==================== UI 配置 ====================
+  @override
+  String get title => '${nameTitle}';
+
+  // ==================== ViewModel ====================
+  @override
+  ${namePascal}ViewModel createViewModel() => ${namePascal}ViewModel();
+
+  // ==================== UI 构建 ====================
+  @override
+  Widget buildContent(BuildContext context) {
+    return Center(
+      child: Text('${namePascal}Page'),
+    );
+  }
+}
+`;
+  } else if (stateful) {
+    // 普通 StatefulWidget (无 ViewModel)
+    return `${imports}
+class ${namePascal}Page extends StatefulWidget {
+  const ${namePascal}Page({super.key});
+
+  @override
+  State<${namePascal}Page> createState() => _${namePascal}PageState();
+}
+
+class _${namePascal}PageState extends State<${namePascal}Page> {
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text('${nameTitle}'),
+      ),
+      body: Center(
+        child: Text('${namePascal}Page'),
+      ),
+    );
+  }
+}
+`;
+  } else {
+    // StatelessWidget
+    return `${imports}
+class ${namePascal}Page extends StatelessWidget {
+  const ${namePascal}Page({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text('${nameTitle}'),
+      ),
+      body: Center(
+        child: Text('${namePascal}Page'),
+      ),
+    );
+  }
+}
+`;
+  }
+}
+
+/**
+ * 生成 ViewModel
+ */
+function generateViewModel (name, options = {}) {
+  const { feature = null, outputDir = process.cwd(), template = 'lite', isListPage = false } = options;
+
+  const namePascal = toPascalCase(name);
+  const nameSnake = toSnakeCase(name);
+
+  // 根据模板类型确定输出路径
+  const vmDir = getViewModelPath(outputDir, feature);
+
+  if (!existsSync(vmDir)) {
+    mkdirSync(vmDir, { recursive: true });
+  }
+
+  // 根据片段或模板类型生成内容
+  const snippetKey = isListPage ? 'flu.listViewModel' : 'flu.viewmodel';
+  const vmSnippet = getSnippetContent(outputDir, snippetKey, {
+    Name: namePascal,
+    snake_name: nameSnake,
+    ModelName: namePascal + 'Model'
+  });
+  let content = vmSnippet;
+  if (template === 'clean') {
+    // Clean 架构的 ViewModel 需要依赖 UseCase
+    content = content || `import 'package:flutter/foundation.dart';
+
+class ${namePascal}ViewModel extends ChangeNotifier {
+  // TODO: 注入 UseCase
+  // final GetSomething getSomething;
+  
+  // ${namePascal}ViewModel({
+  //   required this.getSomething,
+  // });
+
+  void init() {
+    // 初始化逻辑
+  }
+
+  @override
+  void dispose() {
+    // 清理资源
+    super.dispose();
+  }
+}
+`;
+  } else {
+    // Lite 和 Modular 使用标准的 ViewModel
+    content = content || `import 'package:flutter/foundation.dart';
+
+class ${namePascal}ViewModel extends ChangeNotifier {
+  void init() {
+    // 初始化逻辑
+  }
+
+  @override
+  void dispose() {
+    // 清理资源
+    super.dispose();
+  }
+}
+`;
+  }
+
+  const filePath = join(vmDir, `${nameSnake}_viewmodel.dart`);
+  if (existsSync(filePath)) {
+    logger.warn(`ViewModel 已存在: ${filePath}`);
+    return false;
+  }
+
+  writeFileSync(filePath, content, 'utf8');
+  logger.success(`ViewModel 创建成功: ${filePath}`);
+
+  // 更新 index.dart
+  updateIndexFile(vmDir, `${nameSnake}_viewmodel.dart`);
+
+  return true;
+}

package/lib/generators/project_generator.js

@@ -0,0 +1,96 @@
+// 项目生成器：复制模板、处理占位、触发状态管理生成
+import { existsSync } from 'fs';
+import fsx from 'fs-extra';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import chalk from 'chalk';
+import { logger } from '../utils/logger.js';
+import { StateManagerGenerator } from './state_manager_generator.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+/**
+ * 项目生成器
+ * 负责复制模板、渲染入口与依赖、并执行状态管理器配置
+ */
+export class ProjectGenerator {
+  /**
+   * 检查项目目录是否存在
+   */
+  checkProjectExists (projectPath) {
+    return existsSync(projectPath);
+  }
+
+  /**
+   * 复制内置模板到目标目录（lite/modular/clean）
+   */
+  async copyTemplate (templateName, projectPath) {
+    const source = join(__dirname, '../../..', `template-${templateName}`);
+    if (!(await fsx.pathExists(source))) {
+      throw new Error(`内置模板不存在: ${source}`);
+    }
+    await fsx.copy(source, projectPath, { overwrite: true });
+    logger.success(`✓ 已复制模板: ${templateName}`);
+    return true;
+  }
+
+  /**
+   * 根据用户选择配置状态管理器（适配器与入口）
+   */
+  async configureStateManager (projectPath, stateManager, options = {}) {
+    const sm = new StateManagerGenerator(projectPath, stateManager, options);
+    await sm.generate();
+  }
+
+  /**
+   * 处理模板占位符：将 .template 文件落地为实际文件
+   */
+  async processTemplates (projectPath) {
+    const pubspecTpl = join(projectPath, 'pubspec.yaml.template');
+    const pubspecOut = join(projectPath, 'pubspec.yaml');
+    if (await fsx.pathExists(pubspecTpl)) {
+      const content = await fsx.readFile(pubspecTpl, 'utf8');
+      await fsx.writeFile(pubspecOut, content);
+      await fsx.remove(pubspecTpl);
+    }
+
+    const mainTpl = join(projectPath, 'lib', 'main.dart.template');
+    const mainOut = join(projectPath, 'lib', 'main.dart');
+    if (await fsx.pathExists(mainTpl)) {
+      const content = await fsx.readFile(mainTpl, 'utf8');
+      await fsx.writeFile(mainOut, content);
+      await fsx.remove(mainTpl);
+    }
+
+    const initScript = join(projectPath, 'init.sh');
+    if (await fsx.pathExists(initScript)) {
+      await fsx.remove(initScript);
+    }
+
+    const analysisTpl = join(projectPath, 'analysis_options.yaml.template');
+    const analysisOut = join(projectPath, 'analysis_options.yaml');
+    if (await fsx.pathExists(analysisTpl)) {
+      const content = await fsx.readFile(analysisTpl, 'utf8');
+      if (await fsx.pathExists(analysisOut)) {
+        await fsx.remove(analysisOut);
+      }
+      await fsx.writeFile(analysisOut, content);
+      await fsx.remove(analysisTpl);
+    }
+
+    // 统一 analysis_options.yaml 内容，避免重复或历史残留
+    const unified = `# 引入 Flutter 官方推荐的 lint 规则集，确保项目遵循社区最佳实践\ninclude: package:flutter_lints/flutter.yaml\n\nlinter:\n  rules:\n    # 文本与导入相关规则\n    # 强制使用单引号，保持字符串风格统一，减少混用带来的视觉差异\n    prefer_single_quotes: true\n    # 对导入语句按字母顺序及来源分组排序，提升可读性并减少合并冲突\n    directives_ordering: true\n\n    # const 与不可变性相关规则\n    # 鼓励使用 const 构造函数，提前暴露编译期常量，减少运行时对象创建\n    prefer_const_constructors: true\n    # 鼓励使用 const 字面量创建不可变集合，进一步节省内存并提升性能\n    prefer_const_literals_to_create_immutables: true\n\n    # 可读性与一致性相关规则\n    # 要求多行参数、集合、列表等末尾加逗号，使格式化后自动换行更美观\n    require_trailing_commas: true\n    # 推荐将类字段声明为 final，强化不可变语义，减少意外修改\n    prefer_final_fields: true\n    # 推荐将局部变量声明为 final，明确变量只赋值一次，降低副作用\n    prefer_final_locals: true\n    # 建议使用 SizedBox 替代 Container 作为空白占位，语义更清晰且性能更好\n    sized_box_for_whitespace: true\n    # 避免使用不必要的 Container 嵌套，减少冗余节点，提升渲染性能\n    avoid_unnecessary_containers: true\n\n    # Flutter 常见建议规则\n    # 在异步操作后使用 BuildContext 时，先检查 mounted，防止异步回调时组件已卸载导致异常\n    use_build_context_synchronously: true\n`;
+    await fsx.writeFile(analysisOut, unified);
+
+    return true;
+  }
+
+  /**
+   * 执行 flutter pub get（调用者触发，不在此直接运行）
+   */
+  async runPubGet () {
+    logger.info(chalk.gray('提示: 请在项目目录中执行 `flutter pub get`'));
+    return true;
+  }
+
+}