AppConfigSettings class

The app_config: section of udara.yaml:

app_config:
  mode: generated                 # or dotenv
  output: lib/udara_config.g.dart
  class_name: UdaraConfig
  exclude: [DEVELOPMENT_TEAM, ASSETS_PATH]
  include: [BANK_NAME, PRIMARY_COLOR]  # optional allow-list

Constructors

AppConfigSettings({required AppConfigMode mode, String output = defaultOutput, String className = defaultClassName, List<String> exclude = defaultExclude, List<String>? include, bool declared = false})
const

Properties

className → String
final
declared → bool
Whether udara.yaml has an app_config: section at all.
final
exclude → List<String>
.env keys that are not compiled into the app.
final
hashCode → int
The hash code for this object.
no setterinherited
include → List<String>?
When set, only these .env keys are compiled into the app (minus exclude). migrate-config fills it with the keys the code reads, so build-only values (signing passwords, connection strings) stay out.
final
isGenerated → bool
no setter
mode → AppConfigMode
final
output → String
Path of the generated Dart file, relative to the project, under lib/.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shipsKey(String key) → bool
Whether key is compiled into the app.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

load(String projectDir) → AppConfigSettings
Reads udara.yaml. Without an app_config: section the project keeps the dotenv behaviour it has always had.

Constants

configFileName → const String
defaultClassName → const String
defaultExclude → const List<String>
Keys only the CLI needs; they never go into the app by default.
defaultOutput → const String