Flutter代码生成插件generators_lite的使用

Flutter代码生成插件generators_lite的使用

概述

generators_lite 是一个基于 package:build_runner 的代码生成工具包，支持多种生成器，包括资源文件、国际化（I18N）、数据类以及图标字体。通过统一的方式管理所有生成器，简化开发流程。

功能概览

目前支持以下生成器：

1. Assets Generator：用于迁移文件结构到嵌套的Dart类。
2. I18N Generator：主要用于处理翻译文件的自动补全。
3. Data Class Generator：从预定义的配置生成完整的Dart类。
4. Icon Fonts Generator：实时生成基于 .svg 文件的Web字体。

安装

在 pubspec.yaml 文件中添加依赖：

dev_dependencies:
  build_runner: any
  generators_lite:

或者直接使用命令行安装并运行：

dart pub global activate generators_lite
generate <command> [arguments]

也可以直接调用主程序：

dart run generators_lite:main <command> [arguments]

例如：

generate assets --import-path source/assets --export-path lib/assets.g.dart
generate i18n -i source/i18n -e lib/i18n.g.dart
generate models -i models.json -e lib/models.g.dart
generate icons -i source/icons -e lib/icons.g.dart

使用

配置 build.yaml

generators_lite 使用 build.yaml 文件进行配置。以下是完整的示例：

# yaml-language-server: $schema=./build.yaml
targets:
  $default:
    sources:
      include:
        - '**'
        - lib/$lib$
        - $package$
      exclude:
        - .dart_tool/**

    builders:
      generators_lite|assets:
        enabled: true
        options:
          import_path: source/assets
          export_path: lib/src/generated/assets.g.dart
          base_name: CustomAssets

      generators_lite|i18n:
        enabled: true
        options:
          import_path: source/i18n
          export_path: lib/src/generated/i18n.g.dart
          encoding: utf-8
          imports:
            - ../custom_l10n.dart
          base_name: CustomI18N
          base_class_name: CustomL10N
          enum_class_name: I18NLocaleCustom

      generators_lite|models:
        enabled: true
        options:
          import_path: source/models.json
          export_path: lib/src/generated/models.g.dart
          imports:
            - ../custom_json_converters.dart

      generators_lite|icons:
        enabled: true
        options:
          import_path: source/icons
          export_path: lib/src/generated/icons.g.dart
          font_export_path: source/icons.ttf
          base_name: CustomIcons
          font_family: IconsFont
          height: 24
          descent: 8
          normalize: true
          npm_package:
            private: true
            devDependencies:
              fantasticon: ^1.2.3
          base_code_point: 0xf101

各生成器详解

Assets Generator

将指定目录的文件结构映射为嵌套的Dart类。

示例配置：

generators_lite|assets:
  enabled: true
  options:
    import_path: source/assets
    export_path: lib/src/generated/assets.g.dart
    base_name: CustomAssets

I18N Generator

用于处理多语言资源文件的自动化生成。

示例配置：

generators_lite|i18n:
  enabled: true
  options:
    import_path: source/i18n
    export_path: lib/src/generated/i18n.g.dart
    base_name: CustomI18N
    base_class_name: CustomL10N
    enum_class_name: I18NLocaleCustom

Data Class Generator

根据预定义的 JSON 或 YAML 文件生成数据类。

示例配置：

generators_lite|models:
  enabled: true
  options:
    import_path: source/models.json
    export_path: lib/src/generated/models.g.dart
    imports:
      - ../custom_json_converters.dart

Icon Fonts Generator

从 .svg 文件生成 Web 字体。

示例配置：

generators_lite|icons:
  enabled: true
  options:
    import_path: source/icons
    export_path: lib/src/generated/icons.g.dart
    font_export_path: source/icons.ttf
    base_name: CustomIcons
    font_family: IconsFont
    height: 24
    descent: 8
    normalize: true
    npm_package:
      private: true
      devDependencies:
        fantasticon: ^1.2.3
    base_code_point: 0xf101

运行生成器

执行以下命令以运行生成器：

dart run build_runner build --delete-conflicting-outputs

为了更方便地集成到 VS Code 中，可以设置任务：

{
  "version": "2.0.0",
  "tasks": [
    {
      "type": "shell",
      "label": "build_runner",
      "command": "flutter",
      "args": [
        "pub",
        "run",
        "build_runner",
        "watch",
        "--delete-conflicting-outputs",
        "--low-resources-mode"
      ],
      "isBackground": true,
      "presentation": {
        "echo": true,
        "reveal": "silent",
        "focus": false,
        "panel": "shared",
        "showReuseMessage": true,
        "clear": false
      },
      "problemMatcher": ["$dart-build_runner"],
      "runOptions": {
        "runOn": "folderOpen"
      }
    }
  ]
}