flu-cli 0.0.4 → 2.0.0

package/CLI.md

@@ -0,0 +1,349 @@
+# Flu-CLI v2 命令参考
+
+> Flutter MVVM 脚手架工具 - 快速生成项目和代码
+
+## 快速开始
+
+```bash
+# 创建新项目
+flu-cli new my_app
+
+# 添加页面
+flu-cli add page home
+
+# 查看帮助
+flu-cli --help
+```
+
+## 命令列表
+
+### 1. `new` - 创建项目
+
+创建一个新的 Flutter 项目，支持多种模板和状态管理器。
+
+**用法:**
+```bash
+flu-cli new [项目名称] [选项]
+flu-cli n [项目名称]  # 简写
+```
+
+**选项:**
+- `-t, --template <type>` - 模板类型: `lite`, `modular`, `clean`
+- `-s, --state <type>` - 状态管理器: `default`, `provider`, `getx`, `riverpod`
+- `-d, --dir <path>` - 项目存放目录（默认：当前目录）
+- `--no-cache` - 不使用缓存，强制从 Git 拉取
+- `--remote` - 使用远程 Gitee 模板（默认使用本地模板）
+
+**示例:**
+```bash
+# 交互式创建（推荐）
+flu-cli new
+
+# 指定项目名和模板
+flu-cli new my_app -t lite
+
+# 指定状态管理器
+flu-cli new my_app -s getx
+
+# 完整配置
+flu-cli new my_app -t modular -s provider -d ~/projects
+```
+
+---
+
+### 2. `add` - 添加组件
+
+在当前项目中添加各种代码组件。
+
+**用法:**
+```bash
+flu-cli add <类型> <名称> [选项]
+flu-cli a <类型> <名称>  # 简写
+```
+
+**支持的类型及别名:**
+
+| 类型 | 别名 | 说明 |
+|------|------|------|
+| `page` | `p` | 页面组件 |
+| `widget` | `w` | 通用组件 |
+| `component` | `c` | 业务组件 |
+| `viewmodel` | `v` | ViewModel |
+| `service` | `s` | 服务层 |
+| `model` | `m` | 数据模型 |
+| `module` | `mod` | 完整功能模块 |
+
+**选项:**
+- `-f, --feature <name>` - 所属功能模块（仅 modular/clean 模式）
+- `--stateful` - 创建 StatefulWidget
+- `--stateless` - 强制创建 StatelessWidget
+- `--list-page` - 创建列表页 (BaseListPage)
+- `--no-vm` - 不生成 ViewModel（仅 page 类型）
+- `--type <type>` - Service 类型: `api`, `storage`, `auth`（仅 service 类型）
+- `--json <file>` - 从 JSON 文件生成（仅 model 类型）
+- `--list` - 查看支持的类型列表
+
+**示例:**
+```bash
+# 添加页面（自动生成 ViewModel）
+flu-cli add page home
+flu-cli add p home  # 简写
+
+# 添加列表页
+flu-cli add page user_list --list-page
+
+# 添加无状态页面
+flu-cli add page about --stateless --no-vm
+
+# 添加组件
+flu-cli add widget custom_button
+flu-cli add w custom_button  # 简写
+
+# 添加 Service
+flu-cli add service api --type api
+flu-cli add s auth --type auth  # 简写 + 指定类型
+
+# 添加 Model
+flu-cli add model user
+flu-cli add m user  # 简写
+
+# 在功能模块下添加（modular/clean 模式）
+flu-cli add page product -f shop
+```
+
+---
+
+### 3. `templates` - 模板管理
+
+查看可用模板列表或指定模板的详细信息。
+
+**用法:**
+```bash
+flu-cli templates [模板名称]
+flu-cli t [模板名称]  # 简写
+```
+
+**示例:**
+```bash
+# 查看所有模板
+flu-cli templates
+
+# 查看指定模板详情
+flu-cli templates lite
+flu-cli t modular  # 简写
+```
+
+---
+
+### 4. `generate-sm` - 生成状态管理代码
+
+为现有项目生成状态管理适配与配置。
+
+**用法:**
+```bash
+flu-cli generate-sm <类型>
+flu-cli g <类型>  # 简写
+```
+
+**选项:**
+- `-d, --dir <path>` - 项目目录（默认：当前目录）
+- `-m, --module <name>` - 模块名称（modular/clean 支持分模块适配器）
+
+**示例:**
+```bash
+# 生成 Provider 状态管理
+flu-cli generate-sm provider
+
+# 生成 GetX 状态管理
+flu-cli g getx  # 简写
+```
+
+---
+
+### 5. `sync-snippets` - 同步代码片段
+
+将最新的标准 VS Code 代码片段同步到当前项目。
+
+**用法:**
+```bash
+flu-cli sync-snippets
+flu-cli sync  # 简写
+```
+
+**说明:**
+- 该命令会覆盖项目的 `.vscode/dart.code-snippets` 文件。
+- 新项目创建时会自动同步，无需手动执行。
+
+**示例:**
+```bash
+# 同步标准代码片段
+flu-cli sync-snippets
+```
+
+---
+
+### 6. `update-templates` - 更新模板缓存
+
+更新本地模板缓存到最新版本。
+
+**用法:**
+```bash
+flu-cli update-templates [模板名称]
+flu-cli u [模板名称]  # 简写
+```
+
+**选项:**
+- `--force` - 强制刷新并清理未跟踪文件
+
+**示例:**
+```bash
+# 更新所有模板
+flu-cli update-templates
+
+# 更新指定模板
+flu-cli u lite  # 简写
+
+# 强制刷新
+flu-cli update-templates --force
+```
+
+---
+
+### 7. `cache` - 缓存管理
+
+管理本地模板缓存。
+
+**用法:**
+```bash
+flu-cli cache <action>
+flu-cli c <action>  # 简写
+```
+
+**支持的操作:**
+- `clean` - 清理缓存
+
+**示例:**
+```bash
+# 清理缓存
+flu-cli cache clean
+flu-cli c clean  # 简写
+```
+
+---
+
+### 8. `completion` - 自动补全
+
+生成 Shell 自动补全脚本（支持 Bash/Zsh）。
+
+**用法:**
+```bash
+flu-cli completion
+flu-cli comp  # 简写
+```
+
+**安装方法:**
+```bash
+# Zsh
+flu-cli completion >> ~/.zshrc
+source ~/.zshrc
+
+# Bash
+flu-cli completion >> ~/.bashrc
+source ~/.bashrc
+```
+
+---
+
+## 常见工作流
+
+### 创建新项目
+```bash
+flu-cli new my_app
+cd my_app
+flutter pub get
+flu-cli add page home
+flu-cli add page user_list --list-page
+```
+
+### 在现有项目中使用
+```bash
+cd existing_project
+
+# 同步代码片段
+flu-cli sync-snippets
+
+# 添加组件
+flu-cli add page settings
+flu-cli add service api --type api
+```
+
+### Modular 架构项目
+```bash
+flu-cli new my_app -t modular
+cd my_app
+
+# 在 shop 模块下添加页面
+flu-cli add page product -f shop
+flu-cli add page cart -f shop
+
+# 在 user 模块下添加页面
+flu-cli add page profile -f user
+```
+
+---
+
+## 全局选项
+
+所有命令都支持以下选项：
+- `-V, --version` - 查看版本号
+- `-h, --help` - 查看帮助信息
+
+**示例:**
+```bash
+flu-cli --version
+flu-cli add --help
+```
+
+---
+
+## 配置文件
+
+Flu-CLI 会在以下位置存储配置：
+- **缓存目录**: `~/.flu-cli/cache/`
+- **配置文件**: `~/.flu-cli/config.json`
+
+---
+
+## 故障排除
+
+### 命令卡住
+如果命令执行过程中卡住，可以：
+1. 按 `Ctrl+C` 中止
+2. 运行 `flu-cli cache clean` 清理缓存
+3. 重新执行命令
+
+### 模板拉取失败
+```bash
+# 清理缓存后重试
+flu-cli cache clean
+flu-cli new my_app
+
+# 或使用本地模板（开发环境）
+flu-cli new my_app --no-cache
+```
+
+### 代码片段不生效
+```bash
+# 重新同步代码片段
+flu-cli sync-snippets
+
+# 重启 VS Code 后生效
+```
+
+---
+
+## 更多帮助
+
+- 查看具体命令帮助：`flu-cli <command> --help`
+- 项目文档：[flu-cli 文档站](https://your-docs-url)
+- 问题反馈：[GitHub Issues](https://github.com/your-repo/issues)

package/README.md

@@ -1,182 +1,86 @@
-# Flu CLI 工具
+# flu-cli v2.0
 
-火之夜工作室 Flutter 项目创建工具，基于 Node.js 实现的命令行工具，用于快速创建和配置 Flutter 项目。
+> 🚀 **活跃开发中** - Flutter MVVM 脚手架工具
 
-## 功能特点
+## ✨ 特性
 
-- **交互式命令行界面**：简化项目创建流程，引导用户完成各项配置
-- **多项目类型支持**：可创建应用(app)、模块(module)、包(package)和插件(plugin)四种项目类型
-- **丰富的模板选择**：提供四种模板类型，满足不同开发需求
-  - **仅基础项目(only)**：仅包含Flutter官方基础项目结构
-  - **最小模板(min)**：基础结构+路由管理+主题管理
-  - **标准模板(normal)**：最小模板+状态管理+工具集+UI组件库
-  - **高级模板(pro)**：标准模板+网络请求+数据缓存+示例模块
-- **灵活的状态管理**：支持原生setState、GetX等多种状态管理方案
-- **自动化配置**：自动处理包名替换、项目命名和依赖管理
-- **开发环境集成**：自动配置VSCode开发环境（代码风格、调试配置、扩展推荐）
-- **依赖包管理**：支持通过Git仓库自动集成常用工具库和网络请求库
-- **IDE自动打开**：创建完成后可自动在VSCode或Android Studio中打开项目
-- **跨平台支持**：兼容Windows、macOS和Linux操作系统
+- 🎯 **交互式创建** - `flu new` 命令提供友好的交互式体验
+- 🔧 **代码生成** - `flu add` 快速生成页面、组件、服务等（支持别名）
+- 📦 **多种模板** - lite、modular、clean 三种架构模板
+- 🎮 **状态管理** - 支持 default、provider、getx、riverpod
+- 📝 **基于 Snippets** - 可自定义 VSCode 代码片段
+- 🎨 **列表页支持** - `--list-page` 自动生成 Page/ViewModel/Model
+- 🚀 **智能补全** - Shell 自动补全（Zsh/Bash）
+- 🌏 **中文友好** - 全中文提示和文档
 
-## 安装
-
-### 全局安装
+## 📦 安装
 
 ```bash
 npm install -g flu-cli
 ```
 
-### 本地安装
-
-```bash
-npm install flu-cli
-```
-
-## 使用方法
-
-### 命令行使用
-
-```bash
-# 如果全局安装
-flu-cli
-
-# 或者使用 npx
-npx flu-cli
-```
-
-### 创建新项目
+## 🚀 快速开始
 
 ```bash
-flu-cli create
-```
+# 创建新项目
+flu-cli new my_app
+# 或使用别名
+flu n my_app
 
-### 命令行参数示例
+# 指定模板和状态管理
+flu n my_app -t modular -s getx
 
-可以直接通过命令行参数指定所有配置，无需交互式输入：
+# 添加页面（自动生成 ViewModel）
+cd my_app
+flu add page home
+# 或使用别名
+flu a p home
 
-```bash
-# 创建应用项目（高级模板+GetX状态管理+VSCode）
-flu-cli create --project-type app --template-type pro --state-manager GetX --project-name my_flutter_app --package-name com.example.myapp --parent-dir ~/your projects path --ide vscode
-
-# 创建模块项目（标准模板+State状态管理 + Android Studio）
-flu-cli create --project-type module --template-type normal --state-manager state --project-name my_flutter_module --package-name com.example.mymodule --parent-dir ~/your projects path --ide android_studio
-
-# 最小化模板快速创建
-flu-cli create --project-type app --template-type min --project-name quick_start --package-name com.example.quick --parent-dir ~/your projects path
+# 添加列表页（自动生成 Page + ViewModel + Model）
+flu a p user_list --list-page
 
-# 仅仅创建一个flutter项目
-flu-cli create --project-type app --template-type only --project-name quick_start --package-name com.example.quick --parent-dir ~/your projects path
-```
+# 添加服务
+flu a s api --type api
 
-#### 参数说明
-
-| 参数 | 说明 | 可选值 |
-| --project-type | 项目类型 | app, module, package, plugin |
-| --template-type | 模板类型 | only, min, normal, pro |
-| --state-manager | 状态管理方案 | state, GetX,   |
-| --project-name | 项目名称 | 小写字母、数字和下划线组合 |
-| --package-name | 包名 | 类似Java包名格式，如com.example.app |
-| --parent-dir | 存放目录 | 绝对路径或相对路径 |
-| --ide | IDE选择 | vscode, android_studio, open_folder, manual |
-| --flutter-sdk | Flutter SDK路径 | 默认为系统环境变量中的flutter |
-
-按照提示完成以下步骤：
-
-1. **选择项目类型**：应用(app)、模块(module)、包(package)或插件(plugin)
-2. **选择模板类型**：基础(only)、最小(min)、标准(normal)或高级(pro)
-3. **选择状态管理**：根据模板类型选择合适的状态管理方案（高级模板需要）
-4. **输入项目信息**：项目名称、包名和存放路径
-5. **确认配置**：确认项目信息和覆盖选项
-6. **选择IDE**：选择用于打开项目的IDE
-
-## 模板详情
-
-### 仅基础项目(only)
-- 包含Flutter官方创建的基础项目结构
-- 仅保留核心文件：`main.dart`、`pubspec.yaml`和基础目录结构
-- 适用于快速测试或需要完全自定义项目结构的场景
-
-### 最小模板(min)
-- 基于基础项目扩展，增加以下功能：
-  - 路由管理：使用`auto_route`实现路由配置和导航
-  - 主题管理：支持亮色/暗色主题切换
-  - 基础工具类：包含常用字符串、日期处理方法
-
-### 标准模板(normal)
-- 基于最小模板扩展，增加以下功能：
-  - 状态管理：根据选择集成对应状态管理库
-  - UI组件库：基础按钮、输入框、列表项等常用组件
-  - 网络请求：基于`dio`的基础网络请求封装
-  - 本地存储：使用`shared_preferences`实现简单数据存储
-
-### 高级模板(pro)
-- 基于标准模板扩展，增加以下功能：
-  - 完整网络层：请求拦截、响应处理、错误统一管理
-  - 数据缓存：实现网络数据缓存策略
-  - 业务模块划分：按功能模块组织代码结构
-  - 示例功能：包含登录、列表等示例页面
-  - 依赖注入：使用`get_it`实现服务定位
-
-## 项目结构
+# 同步代码片段
+flu sync-snippets
 
+# 生成自动补全脚本
+flu-cli completion >> ~/.zshrc && source ~/.zshrc
 ```
-flutter-cli/
-├── index.js                  # 主入口文件
-├── package.json              # 项目配置
-├── README.md                 # 项目说明文档
-└── lib/                      # 核心功能模块
-    ├── createProject.js      # 项目创建主流程协调
-    ├── userInteraction.js    # 用户交互功能（输入、选择、确认）
-    ├── flutterProjectCreator.js # Flutter项目创建（执行flutter create命令）
-    ├── libCopier.js          # 模板文件复制和处理
-    ├── utils.js              # 工具函数（验证、格式化、IDE打开等）
-    └── desktopPath.js        # 桌面路径获取
-```
-
-### 核心模块说明
 
-- **createProject.js**：协调整个项目创建流程，包括用户交互、项目初始化、模板复制和环境配置
-- **userInteraction.js**：提供所有交互式功能，包括获取项目类型、模板类型、状态管理、项目信息等
-- **flutterProjectCreator.js**：执行`flutter create`命令创建基础项目，处理不同项目类型参数
-- **libCopier.js**：负责模板文件复制、占位符替换和Git仓库克隆操作
-- **utils.js**：提供各种辅助功能，如名称验证、彩色输出、README生成和IDE自动打开
+## 📚 命令别名
 
-## 依赖项
+### add 类型别名
+- `p` = page
+- `w` = widget  
+- `c` = component
+- `v` = viewmodel
+- `s` = service
+- `m` = model
+- `mod` = module
 
-- inquirer: 交互式命令行界面
-- chalk: 终端彩色输出
-- commander: 命令行参数解析
-- ora: 终端加载动画
-- fs-extra: 文件系统操作增强
-- child_process: 执行系统命令
+### 顶级命令别名
+- `n` = new
+- `a` = add
+- `t` = templates
+- `g` = generate-sm
+- `u` = update-templates
+- `c` = cache
+- `sync` = sync-snippets
+- `comp` = completion
 
-## 开发
+## 📚 文档
 
-### 本地开发
-
-```bash
-# 克隆仓库
-git clone https://gitee.com/tengteng_fan/flutter-cli.git
-cd flutter-cli
-
-# 安装依赖
-npm install
-
-# 链接到全局
-npm link
-
-# 测试运行
-flu-cli
-```
+- [CLI 命令参考](./CLI.md) - 详细命令说明
+- [完整文档](http://huozhiye.cn/flu-cli/) - 主文档站
 
-## 注意事项
+## 🔗 相关链接
 
-- 确保系统已正确安装 Flutter SDK 并添加到环境变量
-- 使用前可运行 `flutter doctor` 检查 Flutter 安装状态
-- 项目创建过程中需要网络连接以从 Git 仓库获取模板
-- 高级模板可能需要较长时间下载依赖，请耐心等待
-- 如遇权限问题，在命令前添加`sudo`（macOS/Linux）或使用管理员权限运行终端（Windows）
+- [模板对比](http://huozhiye.cn/flu-cli/guide/templates/template-comparison)
+- [最佳实践](http://huozhiye.cn/flu-cli/best-practices/custom-templates)
+- [从 V1 迁移](http://huozhiye.cn/flu-cli/examples/migration)
 
-## 许可证
+## 📄 许可
 
-MIT
+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;
+}