flutter_setup library
Production-ready Flutter project scaffolding, development, and release automation library.
Classes
- BuildContext
- Context parameters configured for an execution of the Flutter build subsystem.
- BuildManager
- Central coordinator for executing Flutter compilation and packaging commands.
- BuildResult
- Detailed result report for an individual Flutter compilation operation.
- CliApp
- Central CLI Application coordinator.
- CliOptions
- Represents parsed global command options.
- DependencyConfig
- Represents a package dependency declaration in a template configuration.
- DeploymentContext
- Context holding parameters for a store deployment operation.
- DeploymentManager
- Central coordinator for executing store deployment strategies.
- DeploymentResult
- Result object describing the outcome of a store deployment operation.
- EnvironmentConfig
- Configuration definition for a target release channel / execution environment.
- FeatureGenerator
- Service responsible for rendering feature and sub-component fragments into an existing Flutter project.
- GitClient
-
Client wrapping external
gitCLI operations. - GitOperationResult
- Result object for Git operations like tag creation.
- NotificationPayload
- Provider-neutral notification model.
- NotificationResult
- Result object describing the delivery status of a notification provider attempt.
- ProjectGenerator
- Production implementation of Generator that orchestrates Flutter project creation, template rendering, package dependency installation, and asset processing.
- ReleaseConfig
- Configuration options for release automation.
- ReleaseContext
- Context object carrying runtime state and options across the release execution pipeline.
- ReleaseEvent
- Structured model capturing data associated with a release lifecycle event.
- ReleaseManager
- Central orchestrator coordinating release validation, version management, and strategy execution.
- ReleaseMetadata
- Machine-readable metadata model describing a completed release or patch operation.
- ReleaseResult
- Structured result model communicating the outcome of a release execution.
- ReleaseStateRecord
- Machine-readable state record capturing active or historical release execution details.
- ShorebirdClient
-
Client wrapping external
shorebirdCLI operations using ProcessRunner. - ShorebirdCommandResult
- Structured result returned by ShorebirdClient command invocations.
- Template
- Entity representing a project scaffolding template.
- TemplateConfig
- Typed configuration model representing a template's metadata and specs.
- TemplateRegistry
- Registry responsible for discovering, registering, and retrieving templates.
- TemplateRepository
- Contract for retrieving and querying templates.
- TerminalOutput
- Abstraction for standard CLI output formatting and output streams.
- VersionManager
- Service managing reading, calculating, and updating Flutter project versions.
Enums
- BuildFormat
- Supported compilation artifact output formats for Flutter builds.
- BuildPlatform
- Target platforms supported for Flutter build compilation and deployment.
- NotificationSeverity
- Severity level for a notification.
- ReleaseEventType
- Types of release lifecycle events.
- ReleaseStatus
- Status state of a release or patch operation lifecycle.
- ReleaseType
- Strongly typed representation of supported release modes.
- TargetEnvironment
- Supported release channels and target execution environments.
- VersionBumpMode
- Version bump mode for version management operations.
Exceptions / Errors
- AssetGenerationException
- Exception thrown when asset constant generation fails due to persistent naming collisions or I/O errors.
- BuildException
- Exception thrown when Flutter / Shorebird application build stage fails.
- CliException
-
Base exception class for
flutter_setupCLI errors. - ConfigurationException
- Exception thrown when configuration parsing fails.
- DeploymentException
- Exception thrown when Fastlane store deployment stage fails.
- DestinationConflictException
- Exception thrown when target destination path or file already exists and cannot be overwritten.
- FlutterCommandException
-
Exception thrown when executing external
flutterprocess commands fails. - PackageInstallException
- Exception thrown when installing package dependencies fails.
- ReleaseSafetyException
- Exception thrown when release safety checks or eligibility rules fail.
- TemplateException
- Exception thrown when a template cannot be found, loaded, or parsed.
- TemplateNotFoundException
- Exception thrown when a requested template is missing.
- ToolNotFoundException
- Exception thrown when required external tool discovery fails.
- UnresolvedTokenException
- Exception thrown when template rendering contains unresolved variable tokens.
- ValidationException
- Exception thrown when command input or arguments fail validation.