flu-cli

主题

安装指南 ​

本指南将帮助你安装和配置 Flu CLI VSCode 扩展。

系统要求 ​

必需 ​

  • VSCode: >= 1.80.0
  • Flutter SDK: >= 3.0.0
  • Dart SDK: >= 3.0.0

推荐 ​

  • Git: 用于自定义 Git 模板功能
  • Node.js: 如果需要使用 CLI 工具

安装扩展 ​

方式 1：VSCode 市场安装（推荐） ​

  1. 打开 VSCode
  2. 点击左侧活动栏的扩展图标（或按快捷键）
    • macOS: Cmd+Shift+X
    • Windows/Linux: Ctrl+Shift+X
  3. 在搜索框中输入 "Flu CLI"
  4. 找到 "Flu CLI for VSCode" 扩展
  5. 点击 "安装" 按钮
  6. 等待安装完成

方式 2：命令面板安装 ​

  1. 打开命令面板
    • macOS: Cmd+Shift+P
    • Windows/Linux: Ctrl+Shift+P
  2. 输入 Extensions: Install Extensions
  3. 搜索 "Flu CLI"
  4. 点击安装

方式 3：VSIX 文件安装 ​

如果你有 .vsix 安装包：

  1. 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
  2. 输入 Extensions: Install from VSIX...
  3. 选择 .vsix 文件
  4. 等待安装完成

方式 4：命令行安装 ​

bash
code --install-extension huoye-studio.flu-cli-vscode

验证安装 ​

检查扩展状态 ​

  1. 打开扩展面板（Cmd+Shift+X / Ctrl+Shift+X）
  2. 搜索 "Flu CLI"
  3. 确认显示 "已启用" 状态

检查命令可用性 ​

  1. 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
  2. 输入 Flu
  3. 应该能看到以下命令：
    • Flu: New Project / Flu: 新建项目
    • Flu: Generate / Flu: 生成文件
    • Flu: Init / Flu: 初始化项目

检查右键菜单 ​

  1. 在资源管理器中右键点击任意文件夹
  2. 应该能看到以下菜单项：
    • Flu: 新建项目 / Flu: New Project
    • Flu: 生成文件 / Flu: Generate
    • Flu: 初始化项目 / Flu: Init

配置扩展 ​

基本配置 ​

扩展开箱即用，无需额外配置。但你可以根据需要自定义设置。

打开设置 ​

  1. 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
  2. 输入 Preferences: Open Settings (UI)
  3. 搜索 "Flu CLI"

可用设置 ​

目前扩展使用项目级配置文件 .flu-cli.json，无需全局设置。

初始化项目配置 ​

在现有项目中使用扩展前，建议初始化配置文件：

方式 1：右键菜单 ​

  1. 在项目根目录右键
  2. 选择 Flu: 初始化项目
  3. 自动生成 .flu-cli.json

方式 2：命令面板 ​

  1. 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
  2. 输入 Flu: Init
  3. 自动生成配置文件

生成的配置文件示例：

json
{
    "generators": {
        "page": {
            "path": "lib/pages",
            "defaultType": "stateful",
            "withViewModel": true,
            "withBasePage": false
        },
        "viewModel": {
            "path": "lib/viewmodels",
            "withBaseViewModel": false
        },
        "widget": {
            "path": "lib/widgets",
            "defaultType": "stateless"
        },
        "model": {
            "path": "lib/models"
        }
    }
}

详细配置说明请查看 配置详解。

更新扩展 ​

自动更新（推荐） ​

VSCode 默认会自动更新扩展。你可以在设置中确认：

  1. 打开设置（Cmd+, / Ctrl+,）
  2. 搜索 extensions.autoUpdate
  3. 确保设置为 true

手动更新 ​

  1. 打开扩展面板（Cmd+Shift+X / Ctrl+Shift+X）
  2. 搜索 "Flu CLI"
  3. 如果有更新，会显示 "更新" 按钮
  4. 点击更新

检查更新 ​

  1. 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
  2. 输入 Extensions: Check for Extension Updates

卸载扩展 ​

方式 1：扩展面板 ​

  1. 打开扩展面板（Cmd+Shift+X / Ctrl+Shift+X）
  2. 搜索 "Flu CLI"
  3. 点击扩展右侧的齿轮图标
  4. 选择 "卸载"
  5. 重启 VSCode

方式 2：命令行 ​

bash
code --uninstall-extension huoye-studio.flu-cli-vscode

故障排除 ​

扩展无法启动 ​

症状：安装后扩展不显示或无法使用

解决方案：

  1. 重启 VSCode
  2. 检查 VSCode 版本是否 >= 1.80.0
  3. 查看输出面板的错误信息：
    • 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
    • 输入 Developer: Show Logs
    • 选择 Extension Host

命令不显示 ​

症状：命令面板中找不到 Flu 命令

解决方案：

  1. 确认扩展已启用（扩展面板中检查）
  2. 重新加载窗口：
    • 打开命令面板
    • 输入 Developer: Reload Window

右键菜单不显示 ​

症状：右键点击文件夹时没有 Flu 选项

解决方案：

  1. 确保右键点击的是文件夹，不是文件
  2. 确认扩展已启用
  3. 重启 VSCode

Flutter SDK 未找到 ​

症状：创建项目时提示找不到 Flutter SDK

解决方案：

  1. 确认 Flutter 已正确安装：
    bash
    flutter --version
  2. 确认 Flutter 在系统 PATH 中：
    bash
    which flutter  # macOS/Linux
where flutter  # Windows
  3. 重启 VSCode 以刷新环境变量

权限问题 ​

症状：创建项目或文件时提示权限不足

解决方案：

  1. 确认目标目录有写入权限
  2. macOS/Linux 用户可能需要：
    bash
    sudo chown -R $USER:$USER /path/to/directory
  3. Windows 用户以管理员身份运行 VSCode

多工作区支持 ​

扩展支持 VSCode 多工作区（Multi-root Workspace）：

  1. 每个工作区可以有独立的 .flu-cli.json 配置
  2. 右键菜单会根据当前工作区的配置生成文件
  3. 自定义模板在所有工作区间共享

与其他扩展的兼容性 ​

Flu CLI 扩展与以下扩展完美兼容：

  • Flutter: 官方 Flutter 扩展
  • Dart: 官方 Dart 扩展
  • Awesome Flutter Snippets: 代码片段扩展
  • Flutter Widget Snippets: 组件片段扩展
  • Pubspec Assist: pubspec.yaml 辅助工具

下一步 ​

安装完成后，你可以：

获取帮助 ​

如果遇到安装问题：

Released under the MIT License.

Copyright © 2024 火之夜工作室