index_generator 2.0.3 index_generator: ^2.0.3 copied to clipboard
Automatically generate index / barrel files with all the export needed for your library.
Index Generator #
Automatically generate index / barrel files with all the exports needed for your library.
- Add in your
dev_dependicies: index_generator: ^0.0.0 # ... index_generator: filters: - black: .*.g.dart$ # Define the paths of the folders in which to generate the index files indexes: - path: lib
- You can generate index files with one of the following two commands:
flutter pub run index_generator:main
dart run index_generator:main
Advance Usage #
index_generator: # You can define the default name of the index file default_name: barrel # You can define general filters for all indexes filters: - black: .*\.g$ indexes: - path: lib # You can define specific filters for this index filters: - white: .*\include.g$ # You can define specific export folders paths export: - lib/src - path: generator # You can define the name of the index file index_name: main # You can define the name of the library to use within the index library: index_generator
- name: Prioritize ownership in folders, otherwise it will use the one defined in the generator with
default_namekey. If it is missing, if the folder is
libit will use the package name otherwise the folder name
- filters: You can define
blackfilters that remove files from the index but
whitefilters will add them back You can use [RegExp] expressions
- export: You can define specific export folders paths. The path of the folders is relative to the path of the index
Features and bugs #
Please file feature requests and bugs at the issue tracker.