build_runner_core library

Classes

BuildDirectory
BuildEnvironment
Utilities to interact with the environment in which a build is running.
BuilderActionPerformance
The TimeSlice of a builderKey running on primaryInput within a build.
BuilderApplication
A description of which packages need a given Builder or PostProcessBuilder applied.
BuildFilter
Describes a set of files that should be built.
BuildOptions
Manages setting up consistent defaults for all options and build modes.
BuildPerformance
The TimeSlice of an entire build, including all its actions.
BuildPhasePerformance
The TimeSlice of a full BuildPhase within a larger build.
BuildResult
The result of an individual build, this may be an incremental build or a full build.
BuildRunner
BuildState
FailureType
The type of failure
FileBasedAssetReader
Basic AssetReader which uses a PackageGraph to look up where to read files from disk.
FileBasedAssetWriter
Basic AssetWriter which uses a PackageGraph to look up where to write files to disk.
FinalizedAssetsView
A lazily computed view of all the assets available after a build.
FinalizedReader
An AssetReader which ignores deleted files.
IOEnvironment
A BuildEnvironment writing to disk and stdout.
LogSubscription
OutputLocation
OverrideableEnvironment
A BuildEnvironment which can have individual features overridden.
PackageGraph
A graph of the package dependencies for an application.
PackageNode
A node in a PackageGraph.
PostProcessBuilder
A builder which runs in a special phase at the end of the build.
PostProcessBuildStep
A simplified BuildStep which can only read its primary input, and can't get a Resolver or any Resources, at least for now.
RunnerAssetReader
A RunnerAssetReader must implement MultiPackageAssetReader.
RunnerAssetWriter

Enums

BuildStatus
The status of a build.
DependencyType
The type of dependency being used. This dictates how the package should be watched for changes.
UnreadableReason

Constants

cacheDir → const String
Relative path to the cache directory from the root package dir.
entryPointDir → const String
Directory containing automatically generated build entrypoints.

Properties

assetGraphPath → String
Relative path to the asset graph from the root package dir.
final
dartBinary → String
The dart binary from the current sdk.
final
pubBinary → String
The name of the pub binary on the current platform.
final
sdkBin → String
The path to the sdk bin directory on the current platform.
final

Functions

apply(String builderKey, List<BuilderFactory> builderFactories, PackageFilter filter, {bool isOptional = false, bool hideOutput = true, InputSet defaultGenerateFor = const InputSet(), BuilderOptions defaultOptions = BuilderOptions.empty, BuilderOptions? defaultDevOptions, BuilderOptions? defaultReleaseOptions, Iterable<String> appliesBuilders = const []}) → BuilderApplication
Apply each builder from builderFactories to the packages matching filter.
applyPostProcess(String builderKey, PostProcessBuilderFactory builderFactory, {InputSet defaultGenerateFor = const InputSet(), BuilderOptions defaultOptions = BuilderOptions.empty, BuilderOptions? defaultDevOptions, BuilderOptions? defaultReleaseOptions}) → BuilderApplication
Same as apply except it takes PostProcessBuilderFactorys.
applyToRoot(Builder builder, {bool isOptional = false, bool hideOutput = false, InputSet generateFor = const InputSet()}) → BuilderApplication
Apply builder to the root package.
assetGraphPathFor(String path) → String
Relative path to the asset graph for a build script at path
humanReadable(Duration duration) → String
Returns a human readable string for a duration.
logTimedAsync<T>(Logger logger, String description, Future<T> action(), {Level level = Level.INFO}) → Future<T>
Logs an asynchronous action with description before and after.
logTimedSync<T>(Logger logger, String description, T action(), {Level level = Level.INFO}) → T
Logs a synchronous action with description before and after.
overrideGeneratedOutputDirectory(String path) → void
Overrides the generated directory name.
toAll(Iterable<PackageFilter> filters) → PackageFilter
Run a builders if the package matches any of filters
toAllPackages() → PackageFilter
Run a builder on all packages in the package graph.
toDependentsOf(String packageName) → PackageFilter
Run a builder on all packages with an immediate dependency on packageName.
toNoneByDefault() → PackageFilter
Require manual configuration to opt in to a builder.
toPackage(String package) → PackageFilter
Run a builder on a single package.
toPackages(Set<String> packages) → PackageFilter
Run a builder on a collection of packages.
toRoot() → PackageFilter

Typedefs

OnDelete = void Function(AssetId id)

Exceptions / Errors

BuildConfigChangedException
Indicates that a build config file has changed, and the build needs to be re-ran.
BuildScriptChangedException
Indicates that the build script itself has changed, and needs to be re-ran.
CannotBuildException
Indicates that the build cannot be attempted.
NonInteractiveBuildException
Thrown when the build attempts to prompt the users but no prompt is possible.