MelosWorkspaceConfig class

Annotations
  • @immutable

Constructors

MelosWorkspaceConfig({required String path, required String name, required List<Glob> packages, String? sdkPath, HostedGitRepository? repository, Map<String, List<Glob>> categories = const {}, List<Glob> ignore = const [], Scripts scripts = Scripts.empty, IDEConfigs ide = IDEConfigs.empty, CommandConfigs commands = CommandConfigs.empty, PubClientConfig pub = const PubClientConfig(), bool useRootAsPackage = false, bool discoverNestedWorkspaces = false})
MelosWorkspaceConfig.empty()
MelosWorkspaceConfig.emptyWith({String? name, String? path, bool? useRootAsPackage, bool? discoverNestedWorkspaces})
MelosWorkspaceConfig.fromYaml(Map<Object?, Object?> pubspecYaml, {required String path})
factory

Properties

categories → Map<String, List<Glob>>
A map of Globs for paths that should be searched for packages.
final
commands → CommandConfigs
Command-specific configurations.
final
discoverNestedWorkspaces → bool
Whether to recursively discover packages in nested workspaces. Defaults to false.
final
hashCode → int
The hash code for this object.
no setteroverride
ide → IDEConfigs
IDE-specific configurations.
final
ignore → List<Glob>
A list of Globs for paths that should be excluded from the search for packages.
final
name → String
The name of the melos workspace – used by IDE documentation.
final
packages → List<Glob>
A list of Globs for paths that should be searched for packages.
final
path → String
The absolute path to the workspace folder.
final
pub → PubClientConfig
Configuration for interacting with pub or alternate registries.
final
repository → HostedGitRepository?
The hosted git repository which contains the workspace.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scripts → Scripts
A list of scripts that can be executed with melos run or will be executed before/after some specific melos commands.
final
sdkPath → String?
Path to the Dart/Flutter SDK that should be used, unless overridden though the command line option or the environment variable.
final
useRootAsPackage → bool
Whether to include the repository root as a package in the workspace. Defaults to false.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object>
toString() → String
A string representation of this object.
override
toYaml() → YamlNode

Operators

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

Static Methods

fromWorkspaceRoot(Directory workspaceRoot) → Future<MelosWorkspaceConfig>
Loads the MelosWorkspaceConfig for the workspace at workspaceRoot.
handleWorkspaceNotFound(Directory current) → Future<Never>
Handles the case where a workspace could not be found in the current or a parent directory by throwing an error with a helpful message.