搜尋套件、儲存庫與 APP 分類

套件詳情v4.1.2

index_generator

自動為您的程式庫產生索引/條帶/程式庫檔案,包含所有需要的匯出。

AndroidiOSmacOSWindowsLinux
近 30 天下載
2.6萬
喜歡數
33
Pub 分數
140

安裝套件

flutter pub add index_generator

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

index_generator 是一個 Flutter/Dart 套件,可自動產生索引(barrel)檔案,透過為所有相關的 Dart 檔案產生匯出,簡化程式庫的組織。它能減少在管理包含多個模組或套件的大型程式碼庫時的手動工作量,並降低錯誤發生的機率。此工具可透過命令列與開發工作流程無縫整合,確保各目錄間的匯出宣告保持一致且即時更新。非常適合重視乾淨、可維護程式碼結構的開發者。

適用情境

  • 自動化匯出檔案產生
  • 保持庫結構的整潔
  • 簡化套件開發
  • 減少手動匯出錯誤
  • 支援模組化應用架構

主要特色

  • 自動產生 barrel 檔案
  • 命令列整合
  • 支援多個平台
  • 確保一致的匯出
  • 所需設定最少

適合對象

  • 大規模 Flutter 專案
  • 程式庫作者
  • 使用模組化程式碼庫的團隊
  • 尋求自動化的開發者
  • 頻繁檔案重構的專案

使用建議

  • 需要在 pubspec.yaml 中進行設置
  • 可能與手動編輯衝突
  • 最佳使用於受控的目錄結構中
  • 不適合簡單應用
  • 依賴於正確的資料夾組織

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

Index Generator

Automatically generate index / barrel files with all the exports needed for your library.

Stable release

There will be no more breaking changes

Usage

  1. Activate: dart/flutter pub global activate index_generator

  2. Create index_generator.yaml file or add in your pubspec.yaml file:

index_generator:
  exclude:
    - "**.g.dart"
  # Define the paths of the folders in which to generate the index files
  libraries:
    - directory_path: lib
  1. You can generate index files with: <dart|flutter> pub global run index_generator

Advance Usage

See more examples

index_generator:
  # You can define the default name of the index file
  default_file_name: barrel
  # You can define general filters for all indexes
  exclude:
    - "**.g.dart"
    - "{_,**/_}*.dart"
  libraries:
    - directory_path: lib
      # You can define specific filters for this index
      include:
        # You can define specific export folders paths
        - "src/**"
      # You can define specific export dart packages in index file.
      exports:
        - package: package:args/args.dart
          show:
            - ArgResults
          hide:
            - ArgParser
    - directory_path: generator
      # You can define the name of the index file
      file_name: main
      # Disable/Enable the generated code disclaimer
      disclaimer: false
      # Include/Exclude the library keyword in generated file
      include_library: true
      # Comments added on the generated file, like copyright
      comments: |
        Copyright (c) 2020 BreX900
      # Documentation added on the generated file above the library name
      # Note: docs are only included when include_library is true
      docs: |
        Automatically generate index / barrel / library files
        with all the export needed for your library.
      # You can define the name of the library to use within the index
      name: index_generator
      # Use package-style exports for internal files (e.g., 'package:app/main.dart' instead of 'main.dart')
      use_package_exports: true
      # Custom output path for the generated index file (optional)
      # If not specified, the file will be created in the directory_path
      output_path: lib/generated
  • directory_path: Path in which to create the index file. All filters will get the relative path from this directory
  • output_path: Custom output path for the generated index file. If not specified, the file will be created in the directory_path
  • file_name: Prioritize ownership in folders, otherwise it will use the one defined in the generator with default_file_name key. If it is missing, if the folder is lib it will use the package name otherwise the folder name
  • name: The name of the library used in the index dart file by the library keyword
  • include_library: Include or exclude the library keyword in the generated file. Defaults to true
  • docs: Documentation comments added above the library declaration. Only included when include_library is true
  • include | exclude: You can define filters that exclude or include files to be included in the index. The filters are passed paths relative to the index file. You can use Glob expressions.
  • exports: You can define specific export dart packages in index file. You can use package to export a dart file package or dart core library.
  • use_package_exports: When enabled, generates package-style exports for internal files (e.g., 'package:app/main.dart' instead of 'main.dart'). This is useful for libraries that want to ensure consistent import paths. Defaults to false.

Command

--help command output:


-s, --settings=<Define a yaml file path.> If not present use the "index_generator.yaml" file if it exists otherwise use the "pubspec.yaml" file.
-v, --[no-]verbose Print verbose logs
-h, --help

Build runner

index_generator can be run via build_runner. To do so, add the following dependancies:

dev_dependencies:
  build_runner: ^2.10.0
  index_generator: ^4.1.0

and enable it in build.yaml file

targets:
  $default:
    builders:
      index_generator:
        enabled: true

To generate use <dart|flutter> pub run build_runner <build|watch>

Features and bugs

Please file feature requests and bugs at the issue tracker.

Extra

  • mek_assets: Automatically generate dart classes / flutter pubspec entries for your assets files.
  • mek_data_class: Generate hashCode, ==, toString, copyWith and change methods with low code.

所屬分類

依賴

依賴清單 11 項

原始碼儲存庫

使用此套件的專案