BrickYaml class

Mason configuration yaml file which contains metadata used when interacting with the Mason CLI.

Annotations
  • @immutable
  • @JsonSerializable()

Constructors

BrickYaml({required String name, required String description, required String version, String? publishTo, BrickEnvironment environment = const BrickEnvironment(), Map<String, BrickVariableProperties> vars = const <String, BrickVariableProperties>{}, String? repository, String? path})
Mason configuration yaml file which contains metadata used when interacting with the Mason CLI.
const
BrickYaml.fromJson(Map json)
Converts Map to BrickYaml
factory

Properties

description String
Description of the brick.
final
environment BrickEnvironment
Environment of the brick.
final
hashCode int
The hash code for this object.
no setteroverride
name String
Name of the brick.
final
path String?
Path to the BrickYaml file.
final
publishTo String?
Optional url used to specify a custom brick registry as the publish target.
final
repository String?
Optional url pointing to the brick's source code repository.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
vars Map<String, BrickVariableProperties>
Map of variable properties used when templating a brick.
final
version String
Version of the brick (semver).
final

Methods

copyWith({String? path}) BrickYaml
Returns a copy of the current BrickYaml with an overridden path.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map
Converts BrickYaml to Map
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
override

Constants

dir → const String
static constant for brick template directory name. __brick__
file → const String
static constant for brick configuration file name. brick.yaml
hooks → const String
static constant for brick hooks directory name. hooks