ProjectConfig class

Constructors

ProjectConfig({required String appName, required String displayName, required String androidPackage, required String iosBundleId, required StateManagement stateManagement, required bool useFirebase, required bool useSecretKey, StateManagementArchitecture? blocArchitecture, StateManagementArchitecture? riverpodArchitecture, Set<PlatformTarget>? platformTargets, CiCdScope ciCdScope = CiCdScope.none, CiCdProvider ciCdProvider = CiCdProvider.gitlab, GitLabRunnerMode gitlabRunnerMode = GitLabRunnerMode.sharedFlutterImage, Set<DeployTarget>? deployTargets, String? projectRoot, GuideLanguage guideLanguage = GuideLanguage.en, SessionStorageKeys? sessionStorageKeys})

Properties

androidPackage → String
final
appDisplayName → String
no setter
appName → String
final
blocArchitecture → StateManagementArchitecture?
final
ciCdProvider → CiCdProvider
final
ciCdScope → CiCdScope
final
deployTargets → Set<DeployTarget>
final
displayName → String
final
environments → List<String>
no setter
flutterPlatformsArg → String
no setter
gitlabRunnerMode → GitLabRunnerMode
final
gitLabSelfHostedShell → bool
no setter
guideLanguage → GuideLanguage
Language of generated GUIDE.md.
final
hasCiCd → bool
no setter
hasCiDeploy → bool
no setter
hashCode → int
The hash code for this object.
no setterinherited
iosBundleId → String
final
needsCodegen → bool
True when the project uses codegen beyond l10n (freezed, riverpod_generator, …).
no setter
platformTargets → Set<PlatformTarget>
final
projectPath → String
no setter
projectRoot → String?
Absolute path of an existing project.
final
resolvedDeployTargets → Set<DeployTarget>
Resolved deploy targets when hasCiDeploy; defaults to artifactsOnly.
no setter
riverpodArchitecture → StateManagementArchitecture?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionStorageKeys → SessionStorageKeys
Per-project random keys for StorageHelper (32 characters each).
final
stateManagement → StateManagement
final
targetsAndroid → bool
no setter
targetsIos → bool
no setter
targetsWeb → bool
no setter
useFirebase → bool
final
usesDockerRunner → bool
True when GitLab jobs should use the generated ci/Dockerfile.
no setter
useSecretKey → bool
final
usesGitHubActions → bool
no setter
usesGitLabCi → bool
no setter
usesMobileFlavors → bool
--flavor applies to Android and iOS product flavors.
no setter

Methods

androidPackageForEnv(String env) → String
copyWith({String? appName, String? displayName, String? androidPackage, String? iosBundleId, StateManagement? stateManagement, bool? useFirebase, bool? useSecretKey, StateManagementArchitecture? blocArchitecture, StateManagementArchitecture? riverpodArchitecture, Set<PlatformTarget>? platformTargets, CiCdScope? ciCdScope, CiCdProvider? ciCdProvider, GitLabRunnerMode? gitlabRunnerMode, Set<DeployTarget>? deployTargets, String? projectRoot, GuideLanguage? guideLanguage, SessionStorageKeys? sessionStorageKeys}) → ProjectConfig
Copy of this config with selected fields replaced.
iosBundleIdForEnv(String env) → String
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
platformTargetsLabel() → String
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

defaultCiFlavor → const String