barreler 1.1.3

A library for generating barrel files.

Barreler

Barreler is a simple tool to help you manage your barrels in your project. It will generate a barrel file for you, and update it when you add or remove files.

Installation

dart pub global activate barreler

Usage

Create a barreler.yaml file in the root of your project. Then run barreler build to generate the barrel files.

To create an example of the barreler.yaml file, run barreler example.

View the config example for a full example of the barreler.yaml file.

barreler build

Watch for Changes

Barrel files should be updated consistently as you add or remove files from your project. To watch for changes and update the barrel files accordingly, run barreler watch.

The barreler watch command will watch the directories configured in barreler.yaml for changes and update the barrel files. The file events that are watched are create, move, and delete events. The modify event is ignored.

barreler watch

Config Example

# barreler.yaml

line_length: 80
include:
  - "**/*.dart"
exclude:
  - "**/*.g.dart"
defaults:
  file_name: # defaults to directory name
  comments:
  disclaimer: GENERATED CODE - DO NOT MODIFY BY HAND
dirs:
  - path: lib
    name:
    disclaimer: true
    comments:
    exports:
      - package:mario/mario.dart
      - export: package:equatable/equatable.dart
        show:
          - Equatable
        hide:
    include:
      - src/loz.dart
      - export: src/letters.dart
        show:
        hide:
          - A
          - B
          - C
    exclude:
      - src/numbers.dart