deanbot / flutter_monorepo_flavors

approaches for flutter monorepos w/o pub.dev publishing

Monorepo

See melos example.

Setup

• Application packages (packages compiled for devices) are scaffolded in the apps directory. Library packages (packages shared or consumed by application packages) are scaffolded in the packages directory.

example:

root
│   .gitignore
│   [...]
└───apps
│   └───app_a
│   │   └───[...]
│   └───app_b
│       └───[...]
└───packages
    └───app_core
    │   └───[...]
    └───auth_service
        └───[...]

• Shared (library) packages require a directory in packages, a pubspec.yaml, and a same-named barrel file in lib. Private files are placed in lib/src by convention (errors are shown when any consumer imports from src directly).

example:

packages
└───app_core
    │   pubspec.yaml
    │   [...]
    └───lib
        │   app_core.dart
        │   [...]
        └───src
            └───[...]

• In library packages pubspec.lock should be ignored (per https://dart.dev/tools/pub/glossary#library-package).
• Packages which consume library packages use a relative path (instead of version name) within pubspec.yaml.

apps/app_a/pubspec.yaml:

dependencies:
  app_core:
    path: ../packages/app_core

packages/http_album_repository/pubspec.yaml:

dependencies:
  app_core:
    path: ../app_core