flu-cli

主题

常见问题 ​

本文档收集了使用 Flu CLI VSCode 扩展时的常见问题和解答。

安装和配置 ​

Q: 如何安装扩展？ ​

A: 有多种方式：

  1. VSCode 市场（推荐）

    • 打开 VSCode
    • 点击扩展图标（Cmd+Shift+X / Ctrl+Shift+X）
    • 搜索 "Flu CLI"
    • 点击安装

  2. 命令行

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

详见 安装指南

Q: 扩展安装后不显示？ ​

A: 尝试以下方法：

  1. 重启 VSCode
  2. 检查扩展是否已启用（扩展面板中查看）
  3. 重新加载窗口：
    • 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
    • 输入 Developer: Reload Window

Q: 如何更新扩展？ ​

A: VSCode 会自动更新扩展。也可以手动更新：

  1. 打开扩展面板
  2. 搜索 "Flu CLI"
  3. 如果有更新，点击 "更新" 按钮

Q: 如何卸载扩展？ ​

A:

  1. 打开扩展面板
  2. 搜索 "Flu CLI"
  3. 点击齿轮图标 → 卸载
  4. 重启 VSCode

使用问题 ​

Q: 找不到 Flu 命令？ ​

A: 检查以下几点：

  1. 确认扩展已安装并启用
  2. 重新加载 VSCode 窗口
  3. 在命令面板中输入 Flu 查看是否有命令

Q: 右键菜单没有 Flu 选项？ ​

A:

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

Q: 创建项目失败？ ​

A: 可能的原因和解决方案：

  1. Flutter SDK 未安装

    bash
    flutter doctor

  2. 目标目录已存在

    • 选择空目录
    • 或删除现有目录

  3. 网络问题

    • 检查网络连接
    • 使用国内镜像：
      bash
      export PUB_HOSTED_URL=https://pub.flutter-io.cn
export FLUTTER_STORAGE_BASE_URL=https://storage.flutter-io.cn

  4. 权限问题

    • 确认目录有写入权限
    • macOS/Linux: sudo chown -R $USER:$USER /path/to/directory

Q: 生成文件失败？ ​

A: 检查以下几点：

  1. 不在 Flutter 项目中

    • 确认项目根目录有 pubspec.yaml

  2. 配置文件错误

    • 检查 .flu-cli.json 格式是否正确
    • 删除配置文件，使用默认配置

  3. 路径不存在

    • 确认配置的路径存在
    • 或让扩展自动创建

Q: 生成的文件路径不对？ ​

A:

  1. 检查 .flu-cli.json 配置文件
  2. 确认 path 配置正确
  3. 如果使用 {feature} 占位符，确认在正确的位置生成

示例配置：

json
{
    "generators": {
        "page": {
            "path": "lib/features/{feature}/pages"
        }
    }
}

配置问题 ​

Q: 如何初始化配置文件？ ​

A: 有 3 种方式：

  1. 右键菜单（推荐）

    • 在项目根目录右键
    • 选择 Flu: 初始化项目

  2. 命令面板

    • Cmd+Shift+P / Ctrl+Shift+P
    • 输入 Flu: Init

  3. 手动创建

    • 在项目根目录创建 .flu-cli.json
    • 复制默认配置

Q: 配置文件不生效？ ​

A:

  1. 确认配置文件在项目根目录
  2. 检查 JSON 格式是否正确（使用 JSON 验证器）
  3. 重新加载 VSCode 窗口
  4. 查看输出面板的错误信息

Q: 如何自定义生成路径？ ​

A: 编辑 .flu-cli.json：

json
{
    "generators": {
        "page": {
            "path": "lib/pages" // 修改为你的路径
        }
    }
}

Q: 如何不生成 ViewModel？ ​

A: 在配置中设置：

json
{
    "generators": {
        "page": {
            "withViewModel": false
        }
    }
}

Q: 如何使用 BasePage？ ​

A: 配置如下：

json
{
    "generators": {
        "page": {
            "withBasePage": true,
            "basePageClass": "BasePage",
            "basePageImport": "package:my_app/core/base/base_page.dart"
        }
    }
}

模板问题 ​

Q: 如何添加自定义模板？ ​

A:

  1. 创建项目时选择 "自定义模板..."
  2. 选择 "添加自定义模板"
  3. 选择 Git 仓库或本地文件夹
  4. 输入模板信息

详见 自定义模板

Q: Git 模板下载失败？ ​

A:

  1. 检查网络连接

  2. 验证 Git URL

    • 确认 URL 正确
    • 确认有访问权限

  3. 检查 Git 安装

    bash
    git --version

  4. 使用 SSH 认证（私有仓库）

    • 配置 SSH 密钥
    • 使用 SSH URL

Q: 如何删除自定义模板？ ​

A:

  1. 创建项目时选择 "自定义模板..."
  2. 选择 "管理自定义模板"
  3. 选择要删除的模板
  4. 确认删除

Q: 模板无效？ ​

A: 确认模板包含必需文件：

my-template/
├── lib/
│   └── main.dart     # 必需
├── pubspec.yaml      # 必需
└── README.md         # 推荐

代码片段 ​

Q: 代码片段不生效？ ​

A:

  1. 确认文件类型是 .dart
  2. 检查片段前缀是否正确
  3. 尝试重启 VSCode

Q: 如何查看所有片段？ ​

A:

  1. 打开命令面板（Cmd+Shift+P / Ctrl+Shift+P）
  2. 输入 Insert Snippet
  3. 查看可用片段列表

Q: 如何自定义片段？ ​

A:

  1. 打开命令面板
  2. 输入 Preferences: Configure User Snippets
  3. 选择 dart.json
  4. 添加自定义片段

详见 代码片段

性能问题 ​

Q: 创建项目很慢？ ​

A:

  1. 使用国内镜像

    bash
    export PUB_HOSTED_URL=https://pub.flutter-io.cn
export FLUTTER_STORAGE_BASE_URL=https://storage.flutter-io.cn

  2. 使用 SSD 硬盘

  3. 首次创建需要下载模板

    • 后续会使用缓存，速度更快

Q: 生成文件很慢？ ​

A:

  1. 检查磁盘 I/O
  2. 关闭不必要的扩展
  3. 重启 VSCode

与 CLI 工具的区别 ​

Q: VSCode 扩展和 CLI 工具有什么区别？ ​

A:

特性VSCode 扩展CLI 工具
使用方式GUI（右键菜单）命令行
适用场景日常开发自动化、CI/CD
学习成本低中
灵活性中高

Q: 可以同时使用吗？ ​

A: 可以！它们共享相同的配置文件（.flu-cli.json），可以无缝配合使用。

Q: 如何安装 CLI 工具？ ​

A:

bash
npm install -g @flu-cli/cli

详见 CLI 文档

其他问题 ​

Q: 支持哪些 Flutter 版本？ ​

A:

  • 推荐: Flutter >= 3.0.0
  • 最低: Flutter >= 2.0.0

Q: 支持哪些 VSCode 版本？ ​

A:

  • 最低: VSCode >= 1.80.0

Q: 支持哪些操作系统？ ​

A:

  • macOS
  • Windows
  • Linux

Q: 如何查看扩展日志？ ​

A:

  1. 打开输出面板（Cmd+Shift+U / Ctrl+Shift+U）
  2. 在下拉菜单中选择 "Flu CLI"

Q: 如何报告问题？ ​

A:

  1. 访问 Gitee Issues
  2. 点击 "新建 Issue"
  3. 描述问题并提供：
    • VSCode 版本
    • 扩展版本
    • Flutter 版本
    • 错误信息
    • 复现步骤

Q: 如何贡献代码？ ​

A:

  1. Fork 项目
  2. 创建功能分支
  3. 提交代码
  4. 创建 Pull Request

详见 贡献指南

Q: 扩展是免费的吗？ ​

A: 是的，完全免费且开源（MIT 许可证）。

Q: 支持多语言吗？ ​

A: 目前支持中文和英文。

Q: 可以在公司项目中使用吗？ ​

A: 可以！扩展使用 MIT 许可证，可以自由使用。

还有问题？ ​

如果你的问题没有在这里找到答案：

相关链接 ​

Released under the MIT License.

Copyright © 2024 火之夜工作室