SetupConfig class
Configuration for project setup
Constructors
-
SetupConfig({required String appName, required String orgDomain, required String baseClassName, required TemplateType template, required String outputDir, bool createModels = false, bool createServer = false, bool useFirebase = false, String? firebaseProjectId, bool setupCloudRun = false, String? serviceAccountKeyPath, List<
String> platforms = const ['android', 'ios', 'web', 'linux', 'macos', 'windows']}) - SetupConfig.defaults()
-
Create config with defaults
factory
Properties
- appName → String
-
App name in snake_case (e.g., my_app)
final
- baseClassName → String
-
Base class name in PascalCase (e.g., MyApp)
final
- createModels → bool
-
Whether to create models package
final
- createServer → bool
-
Whether to create server app
final
- firebaseProjectId → String?
-
Firebase project ID (required if useFirebase is true)
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- modelsPackageName → String
-
Get the app name for the models package
no setter
- orgDomain → String
-
Organization domain in reverse notation (e.g., com.example)
final
- outputDir → String
-
Output directory for created projects
final
-
platforms
→ List<
String> -
Selected platforms for Flutter app
final
- runnerClassName → String
-
Get the runner class name (PascalCase + Runner)
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverClassName → String
-
Get the server class name (PascalCase + Server)
no setter
- serverPackageName → String
-
Get the app name for the server
no setter
- serviceAccountKeyPath → String?
-
Path to service account key file
final
- setupCloudRun → bool
-
Whether to setup Cloud Run for server
final
- template → TemplateType
-
Selected template
final
- useFirebase → bool
-
Whether to enable Firebase
final
- webClassName → String
-
Get the web class name (PascalCase + Web)
no setter
- webPackageName → String
-
Get the app name for the web package (Jaspr)
no setter
Methods
-
copyWith(
{String? appName, String? orgDomain, String? baseClassName, TemplateType? template, String? outputDir, bool? createModels, bool? createServer, bool? useFirebase, String? firebaseProjectId, bool? setupCloudRun, String? serviceAccountKeyPath, List< String> ? platforms}) → SetupConfig - Create a copy with updated values
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
saveToFile(
String path) → Future< void> - Save configuration to file
-
toDisplayMap(
) → Map< String, String> - Convert to map for display
-
toString(
) → String -
A string representation of this object.
override
-
toYamlString(
) → String - Convert to YAML string for display
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
loadFromFile(
String path) → Future< SetupConfig?> - Load configuration from file