flu-cli 0.0.5 → 2.0.1

package/README.md

@@ -1,303 +1,113 @@
-# Flu CLI 工具
+# flu-cli v2.0
 
-> **flu-cli** 是一个强大的 Flutter 项目脚手架工具，可以帮助您快速创建和配置项目。
+> 🚀 **活跃开发中** - Flutter MVVM 脚手架工具
 
-[![npm version](https://img.shields.io/npm/v/flu-cli.svg)](https://www.npmjs.com/package/flu-cli)
-[![license](https://img.shields.io/npm/l/flu-cli.svg)](https://gitee.com/tengteng_fan/flutter-cli/blob/main/LICENSE)
-[![downloads](https://img.shields.io/npm/dm/flu-cli.svg)](https://www.npmjs.com/package/flu-cli)
+> 💡 **推荐**: 使用 VSCode 开发？试试我们的 [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=flu-cli.flu-cli-vscode)，支持右键生成代码，体验更丝滑！
 
-## 📋 目录
+## ✨ 特性
 
--   [🚀 快速开始](#-快速开始)
--   [📦 安装](#-安装)
--   [🛠️ 使用方法](#️-使用方法)
-    -   [交互式向导](#交互式向导)
-    -   [项目模版对比](#项目模版对比)
-    -   [命令行创建](#命令行创建)
--   [📁 项目结构](#-项目结构)
--   [🏃 运行与调试](#-运行与调试)
--   [📚 进阶指南](#-进阶指南)
--   [🔧 兼容性说明](#-兼容性说明)
-
-## 🚀 快速开始
-
-```bash
-# 全局安装
-npm install -g flu-cli
-
-# 创建项目
-flu-cli
-
-# 或使用 npx（无需安装）
-npx flu-cli
-```
+-   🎯 **交互式创建** - `flu new` 命令提供友好的交互式体验
+-   🔧 **代码生成** - `flu add` 快速生成页面、组件、服务等（支持别名）
+-   📦 **多种模板** - lite、modular、clean 三种架构模板
+-   🎮 **状态管理** - 支持 default、provider、getx、riverpod
+-   📝 **基于 Snippets** - 可自定义 VSCode 代码片段
+-   🎨 **列表页支持** - `--list-page` 自动生成 Page/ViewModel/Model
+-   🚀 **智能补全** - Shell 自动补全（Zsh/Bash）
+-   🌏 **中文友好** - 全中文提示和文档
 
 ## 📦 安装
 
-您可以通过以下方式安装 flu-cli：
-
-| 安装方式       | NPM                      | PNPM                  | Yarn                      |
-| -------------- | ------------------------ | --------------------- | ------------------------- |
-| **全局安装**   | `npm install -g flu-cli` | `pnpm add -g flu-cli` | `yarn global add flu-cli` |
-| **项目内安装** | `npm install flu-cli`    | `pnpm add flu-cli`    | `yarn add flu-cli`        |
-
-> 💡 **推荐使用全局安装**，这样可以在任何地方使用 `flu-cli` 命令。
-
-## 🛠️ 使用方法
-
-### 交互式向导
-
-flu-cli 附带一个命令行设置向导，它将帮助您构建一个基本项目。安装后，您可以通过运行以下命令启动向导：
-
 ```bash
-# 如果全局安装
-flu-cli
-
-# 或者使用 npx
-npx flu-cli
+npm install -g flu-cli
 ```
 
-运行向导后，根据提示输入项目信息，如项目名称、包名、项目类型、模板类型、状态管理方案等。向导会自动生成项目结构并配置相关文件。
-
-<details>
-<summary>📋 向导示例（点击展开）</summary>
+## 🚀 快速开始
 
 ```bash
-欢迎使用 火之夜工作室 Flutter 项目创建工具
-
-? 请选择项目类型: (Use arrow keys)
-❯ 应用 (app)
-  模块 (module)
-  原生插件 (plugin)
-  插件 (package)
-
-? 请选择项目模版: (Use arrow keys)
-  only (main.dart)
-  min (项目结构、路由管理、主题管理、状态管理、工具集)
-  normal (项目结构、路由管理、主题管理、状态管理、工具集、UI 组件库)
-❯ pro (项目结构、路由管理、主题管理、状态管理、工具集、UI 组件库、网络请求、数据缓存、示例模块)
-
-? 请选择状态管理: (Use arrow keys)
-❯ state (State)
-  get (GetX)
-
-? 请输入新项目名称（小写字母、数字和下划线）: (hzy_example_project)
-? 请输入 Flutter SDK 路径（留空使用系统默认）:
-? 请输入包名: (com.example.hzy_example_project)
-? 请输入项目存放路径: (默认: 当前目录)
-
-⚠️  警告: 目标目录 hzy_example_project 已存在!
-? 是否覆盖？ (y/N)
-
-? 请选择要打开项目的 IDE: (Use arrow keys)
-❯ Visual Studio Code
-  Android Studio
-  打开文件夹
-  不打开
-```
-
-</details>
-
-### 项目模版对比
-
-| 功能特性                 | 🔹 only | 🔸 min | 🔶 normal | 🔥 pro |
-| :----------------------- | :-----: | :----: | :-------: | :----: |
-| **基础入口 (main.dart)** |   ✅    |   ✅   |    ✅     |   ✅   |
-| **标准项目结构**         |   ❌    |   ✅   |    ✅     |   ✅   |
-| **路由管理系统**         |   ❌    |   ✅   |    ✅     |   ✅   |
-| **主题管理系统**         |   ❌    |   ✅   |    ✅     |   ✅   |
-| **状态管理方案**         |   ❌    |   ✅   |    ✅     |   ✅   |
-| **开发工具集**           |   ❌    |   ✅   |    ✅     |   ✅   |
-| **UI 组件库**            |   ❌    |   ❌   |    ✅     |   ✅   |
-| **网络请求框架**         |   ❌    |   ❌   |    ❌     |   ✅   |
-| **数据持久化**           |   ❌    |   ❌   |    ❌     |   ✅   |
+# 创建新项目
+flu-cli new my_app
+# 或使用别名
+flu n my_app
 
-#### 模版说明
+# 指定模板和状态管理
+flu n my_app -t modular -s getx
 
--   🔹 **only**：仅保留最小运行单元（适合验证核心功能）
--   🔸 **min**：三大基石（路由/主题/状态管理）
--   🔶 **normal**：增加 UI 组件库（提升开发效率）
--   🔥 **pro**：完整解决方案（含网络层+数据持久化）
+# 添加页面（自动生成 ViewModel）
+cd my_app
+flu add page home
+# 或使用别名
+flu a p home
 
-> 📖 想了解更多项目模版区别，请查看 [项目模版详细说明](http://huozhiye.cn/flu-cli/guide/project-template.html)。
+# 添加列表页（自动生成 Page + ViewModel + Model）
+flu a p user_list --list-page
 
-### 命令行创建
+# 添加服务
+flu a s api --type api
 
-可以直接通过命令行参数指定所有配置，无需交互式输入：
+# 同步代码片段
+flu sync-snippets
 
-#### 基本语法
-
-```bash
-flu-cli create [options]
+# 生成自动补全脚本
+flu-cli completion >> ~/.zshrc && source ~/.zshrc
 ```
 
-#### 使用示例
+## 📚 命令别名
 
-##### 🔥 Pro 模版（推荐）
+### add 类型别名
 
-```bash
-flu-cli create -t app -m pro -s GetX -n my_flutter_app -p com.example.myapp -d ~/projects -i vscode
-```
+-   `p` = page
+-   `w` = widget
+-   `c` = component
+-   `v` = viewmodel
+-   `s` = service
+-   `m` = model
+-   `mod` = module
 
-##### 🔶 Normal 模版
+### 顶级命令别名
 
-```bash
-flu-cli create -t module -m normal -s state -n my_flutter_module -p com.example.mymodule -d ~/projects -i android_studio
-```
+-   `n` = new
+-   `a` = add
+-   `t` = templates
+-   `u` = update-templates
+-   `c` = cache
+-   `sync` = sync-snippets
+-   `comp` = completion
 
-##### 🔸 Min 模版
+## ❓ 获取帮助
 
-```bash
-flu-cli create -t app -m min -n quick_start -p com.example.quick -d ~/projects
-```
-
-##### 🔹 Only 模版
+查看所有命令：
 
 ```bash
-flu-cli create -t app -m only -n quick_start -p com.example.quick -d ~/projects
-```
-
-##### 默认配置（使用向导）
-
-```bash
-flu-cli create
-```
-
-#### 参数说明
-
-| 参数                  | 说明             | 可选值                                              | 必选 | 示例                   |
-| :-------------------- | :--------------- | :-------------------------------------------------- | :--- | :--------------------- |
-| `-t, --project-type`  | 项目类型         | `app`, `module`, `package`, `plugin`                | ✅   | `-t app`               |
-| `-m, --template-type` | 模板类型         | `only`, `min`, `normal`, `pro`                      | ✅   | `-m pro`               |
-| `-s, --state-manager` | 状态管理方案     | `state`, `GetX`, `Riverpod`                         | ❌   | `-s GetX`              |
-| `-n, --project-name`  | 项目名称         | 小写字母、数字和下划线组合                          | ✅   | `-n my_app`            |
-| `-p, --package-name`  | 包名             | 类似 Java 包名格式                                  | ✅   | `-p com.example.myapp` |
-| `-d, --parent-dir`    | 存放目录         | 绝对路径或相对路径                                  | ❌   | `-d ~/projects`        |
-| `-i, --ide`           | IDE 选择         | `vscode`, `android_studio`, `open_folder`, `manual` | ❌   | `-i vscode`            |
-| `-f, --flutter-sdk`   | Flutter SDK 路径 | 默认为系统环境变量中的 flutter                      | ❌   | `-f /path/to/flutter`  |
-| `-h, --help`          | 显示帮助信息     | -                                                   | ❌   | `--help`               |
-
-> 📚 有关更多命令行用法的文档，请参阅 [CLI 参考文档](http://huozhiye.cn/flu-cli/eg/cli-des.html)。
-
-## 📁 项目结构
-
-以下是基于 **GetX** 的完整商业项目结构，清晰的项目结构有助于团队协作和代码维护。
-
-```
-📦 your_project_name/
-├── 📁 .vscode/                    # VS Code 配置文件
-│   ├── 📄 extensions.json         # 插件推荐
-│   ├── 📄 launch.json             # 调试配置
-│   ├── 📄 settings.json           # 编辑器设置
-│   └── 📄 dart.code-snippets      # 代码片段
-├── 📁 assets/                      # 静态资源文件
-│   ├── 📁 fonts/                  # 字体文件
-│   ├── 📁 images/                 # 图片资源
-│   └── 📁 json/                   # 本地数据
-├── 📁 lib/                        # 项目核心代码
-│   ├── 📁 common/                 # 公共组件和工具
-│   ├── 📁 config/                 # 应用配置
-│   ├── 📁 eg_module/              # 示例模块
-│   ├── 📁 init/                   # 初始化逻辑
-│   ├── 📄 main.dart               # 应用入口文件
-│   ├── 📁 models/                 # 数据模型
-│   ├── 📁 network/                # 网络请求
-│   ├── 📁 pages/                  # 页面文件
-│   ├── 📁 tools/                  # 工具类
-│   ├── 📁 vm/                     # 视图模型
-│   └── 📁 widgets/                # UI 组件
-├── 📄 pubspec.yaml                # 项目配置文件
-├── 📄 analysis_options.yaml       # 代码分析配置
-└── 📄 README.md                   # 项目说明文档
+flu-cli --help
 ```
 
-### 📋 目录说明
-
-| 目录/文件         | 说明         | 用途                               |
-| ----------------- | ------------ | ---------------------------------- |
-| 📁 `.vscode/`     | VS Code 配置 | 包含编辑器配置、调试设置和代码片段 |
-| 📁 `assets/`      | 静态资源     | 存放图片、字体、本地数据等资源文件 |
-| 📁 `lib/common/`  | 公共模块     | 公共组件、工具类、常量定义         |
-| 📁 `lib/config/`  | 应用配置     | 环境配置、主题配置、路由配置       |
-| 📁 `lib/network/` | 网络层       | HTTP 请求、API 接口、数据处理      |
-| 📁 `lib/pages/`   | 页面         | 应用的各个页面和子页面             |
-| 📁 `lib/widgets/` | UI 组件      | 可复用的自定义 Widget 组件         |
-| 📁 `lib/models/`  | 数据模型     | 实体类、数据传输对象               |
-| 📁 `lib/vm/`      | 视图模型     | 状态管理、业务逻辑处理             |
-
-## 🏃 运行与调试
-
-### 基本运行步骤
+查看特定命令的详细用法：
 
 ```bash
-# 1. 进入项目目录
-cd /your_project_path/your_project_name
-
-# 2. 获取依赖包
-flutter pub get
-
-# 3. 运行项目（开发模式）
-flutter run
-
-# 4. 构建发布版本
-flutter build apk  # Android
-flutter build ios  # iOS
+flu add --help
+flu new --help
 ```
 
-### 🛠️ 开发工具推荐
-
-| 工具                     | 用途           | 推荐指数   |
-| ------------------------ | -------------- | ---------- |
-| 🔧 **VS Code**           | 轻量级编辑器   | ⭐⭐⭐⭐⭐ |
-| 🔧 **Android Studio**    | 功能完整的 IDE | ⭐⭐⭐⭐   |
-| 🔧 **Flutter Inspector** | UI 调试工具    | ⭐⭐⭐⭐⭐ |
-| 🔧 **Dart DevTools**     | 性能分析工具   | ⭐⭐⭐⭐   |
-
-## 📚 进阶指南
-
-🎉 恭喜您完成了 `flu-cli` 的基础配置！
-
-### 🚀 推荐后续操作
-
--   📖 **深入学习**：查看 [高级特性文档](http://huozhiye.cn/flu-cli/tutorial/base-normal-ui.html)
--   🤝 **项目模版**：访问 [仓库](https://gitee.com/tengteng_fan/hzy_basic_project)
--   📚 **官方文档**：[flu-cli 完整文档](http://huozhiye.cn/flu-cli/)
--   💬 **社区支持**：加入开发者交流群
-
-### 📖 相关资源
-
--   [Flutter 官方文档](https://flutter.dev/docs)
--   [GetX 状态管理](https://github.com/jonataslaw/getx)
--   [Dart 语言指南](https://dart.dev/guides)
-
----
+## 📚 文档
 
-## 🔧 兼容性说明
+-   [CLI 命令参考](http://huozhiye.cn/flu-cli/reference/cli-reference.html) - 详细命令说明
+-   [完整文档](http://huozhiye.cn/flu-cli/) - 主文档站
 
-### 系统要求
+## 💬 加入社区
 
-| 环境            | 最低版本      | 推荐版本      | 状态    |
-| --------------- | ------------- | ------------- | ------- |
-| 🐦 **Flutter**  | 3.0.0+        | 3.16.0+       | ✅ 支持 |
-| 🟢 **Node.js**  | 14.0.0+       | 18.0.0+       | ✅ 支持 |
-| 🖥️ **操作系统** | -             | -             | -       |
-| └─ Windows      | 10+           | 11            | ✅ 支持 |
-| └─ macOS        | 10.14+        | 13.0+         | ✅ 支持 |
-| └─ Linux        | Ubuntu 18.04+ | Ubuntu 22.04+ | ✅ 支持 |
+获取最新动态、反馈问题、定制化开发或与开发者直接交流，欢迎加入我们的微信群：
 
-### 📱 目标平台
+> ![微信群二维码](https://gitee.com/flu-cli/flu-cli/raw/main/packages/vscode-extension/images/wechat-group.png)
 
--   ✅ **Android** 5.0+ (API 21+)
--   ✅ **iOS** 11.0+
--   ✅ **Web** (Chrome, Safari, Firefox)
--   ✅ **Desktop** (Windows, macOS, Linux)
+如果群二维码过期，请添加作者微信 `Huoye-TT` 备注 "flu-cli" 拉您入群。
 
----
+## 🔗 相关链接
 
-<div align="center">
+-   [模板对比](http://huozhiye.cn/flu-cli/guide/templates/template-comparison.html)
+-   [最佳实践](http://huozhiye.cn/flu-cli/best-practices/custom-templates.html)
+-   [从 V1 迁移](http://huozhiye.cn/flu-cli/examples/migration.html)
 
-**🎉 祝您使用 `flu-cli` 开发愉快！**
-[![Gitee Stars](https://gitee.com/tengteng_fan/flutter-cli/badge/star.svg?theme=dark)](https://gitee.com/tengteng_fan/flutter-cli)
-[![Gitee Forks](https://gitee.com/tengteng_fan/flutter-cli/badge/fork.svg?theme=dark)](https://gitee.com/tengteng_fan/flutter-cli)
+ 
+## 📄 许可
 
-</div>
+MIT License - Copyright © 2025 火叶工作室

package/config/dev.config.js

@@ -0,0 +1,56 @@
+/**
+ * 开发配置文件
+ * 
+ * ⚠️ 注意：此文件仅用于开发测试
+ * 发布到 npm 时会被忽略（通过 .npmignore）
+ */
+
+export const DEV_CONFIG = {
+  /**
+   * 是否使用本地模板
+   * 
+   * - true: 优先使用 templates/ 目录下的本地模板（开发模式）
+   * - false: 强制使用 Git 仓库模板（生产模式）
+   * 
+   * 默认：根据环境变量 NODE_ENV 自动判断
+   */
+  useLocalTemplates: process.env.NODE_ENV !== 'production',
+
+  /**
+   * 本地模板目录路径
+   * 相对于项目根目录
+   */
+  localTemplatesPath: './templates',
+
+  /**
+   * 是否显示调试信息
+   */
+  debug: process.env.DEBUG === 'true',
+
+  /**
+   * 是否跳过 Flutter 环境检查（仅开发模式）
+   */
+  skipFlutterCheck: false
+};
+
+/**
+ * 获取配置
+ * 发布版本会强制使用 Git 模板
+ */
+export function getConfig () {
+  // 检查是否为发布版本
+  const isProduction = process.env.NODE_ENV === 'production' || !DEV_CONFIG.useLocalTemplates;
+
+  return {
+    ...DEV_CONFIG,
+    useLocalTemplates: isProduction ? false : DEV_CONFIG.useLocalTemplates,
+    isProduction
+  };
+}
+
+/**
+ * 检查是否为开发模式
+ */
+export function isDevelopment () {
+  return getConfig().useLocalTemplates;
+}

package/config/templates.js

@@ -0,0 +1,147 @@
+/**
+ * 模板配置文件
+ * 定义所有可用的项目模板
+ */
+
+export const TEMPLATES = {
+  lite: {
+    name: 'Lite',
+    displayName: 'Lite - 精简版',
+    description: '最小依赖，单文件结构，适合小型项目和快速原型',
+    local: true,
+    repo: 'https://gitee.com/flu-cli/template-lite.git',
+    branch: 'main',
+    complexity: 1,
+    teamSize: '1 人',
+    codeSize: '< 5k 行',
+    features: [
+      '✅ 最小依赖',
+      '✅ 单文件结构',
+      '✅ Material 3 设计',
+      '✅ 快速启动'
+    ],
+    structure: `
+lib/
+├── 📄 main.dart           # 应用入口
+├── 📄 app.dart            # 应用配置
+├── 📁 pages/              # 页面
+├── 📁 viewmodels/         # 视图模型
+├── 📁 widgets/            # 简单组件
+├── 📁 components/         # 复合组件
+├── 📁 services/           # 业务服务
+├── 📁 models/             # 数据模型
+├── 📁 config/             # 配置
+└── 📁 utils/              # 工具类
+    `
+  },
+
+  modular: {
+    name: 'Modular',
+    displayName: 'Modular - 模块化版',
+    description: '模块化结构，功能分组，适合中型项目',
+    local: true,
+    repo: 'https://gitee.com/flu-cli/template-modular.git',
+    branch: 'main',
+    complexity: 3,
+    teamSize: '2-5 人',
+    codeSize: '5k-20k 行',
+    features: [
+      '✅ 模块化结构',
+      '✅ 路由配置独立',
+      '✅ 主题配置独立',
+      '✅ 功能分组'
+    ],
+    structure: `
+lib/
+├── 📄 main.dart
+├── 📁 core/              # 核心基础设施
+│   ├── theme/            # 主题系统
+│   ├── router/           # 路由系统
+│   ├── constants/        # 常量定义
+│   └── base/             # 基础类（BaseViewModel, BasePage）
+├── 📁 shared/            # 跨模块共享
+│   ├── widgets/          # 通用简单组件
+│   ├── components/       # 通用复合组件
+│   ├── models/           # 通用数据模型
+│   └── utils/            # 通用工具类
+└── 📁 features/          # 业务功能模块
+    ├── hoem/             # 用户模块
+    │   ├── pages/
+    │   ├── viewmodels/
+    │   ├── widgets/
+    │   ├── services/
+    └── └── models/
+    `
+  },
+
+  clean: {
+    name: 'Clean',
+    displayName: 'Clean - 分层版',
+    description: '严格分层架构，清晰的目录结构，适合大型项目',
+    local: true,
+    repo: 'https://gitee.com/flu-cli/template-clean.git',
+    branch: 'main',
+    complexity: 5,
+    teamSize: '5+ 人',
+    codeSize: '> 20k 行',
+    features: [
+      '✅ 严格分层架构',
+      '✅ 清晰的目录结构',
+      '✅ 易于扩展和维护',
+      '✅ 适合团队协作'
+    ],
+    structure: `
+lib/
+├── 📄 main.dart                    # 应用入口
+├── 📄 app.dart                     # 应用配置
+├── 📁 core/                        # 核心层(最内层)
+│   ├── constants/                  # 常量定义
+│   ├── errors/                     # 错误和异常
+│   ├── usecases/                   # UseCase 基类
+│   ├── utils/                      # 工具类
+│   └── network/                    # 网络配置
+├── 📁 features/                    # 功能模块(按业务划分)
+│   └── home/                       # 示例:首页模块
+│       ├── data/                   # 数据层
+│       │   ├── datasources/        # 数据源(API/本地)
+│       │   ├── models/             # 数据模型(DTO)
+│       │   └── repositories/       # Repository 实现
+│       ├── domain/                 # 领域层
+│       │   ├── entities/           # 业务实体
+│       │   ├── repositories/       # Repository 接口
+│       │   └── usecases/           # 用例(业务逻辑)
+│       └── presentation/           # 表现层
+│           ├── pages/              # 页面
+│           ├── widgets/            # 模块专用组件
+│           └── viewmodels/         # 视图模型
+├── 📁 shared/                      # 共享资源
+│   ├── widgets/                    # 通用组件
+│   ├── components/                 # 通用复合组件
+│   └── extensions/                 # 扩展方法
+└── 📁 config/                      # 配置层
+    ├── routes/                     # 路由配置
+    └── theme/                      # 主题配置
+    `
+  }
+};
+
+/**
+ * 获取模板配置
+ */
+export function getTemplate (name) {
+  return TEMPLATES[name];
+}
+
+/**
+ * 获取所有模板
+ */
+export function getAllTemplates () {
+  return Object.values(TEMPLATES);
+}
+
+/**
+ * 验证模板名称
+ */
+export function isValidTemplate (name) {
+  return name in TEMPLATES;
+}