WorkspaceNavigationArgs class

Parsed navigation options for workspace traversal.

Used to configure project discovery behavior across all Tom build tools.

Constructors

WorkspaceNavigationArgs({String? scan, bool recursive = false, bool recursiveExplicitlySet = false, bool buildOrder = false, bool excludeDev = false, String? project, String? root, bool bareRoot = false, bool workspaceRecursion = false, bool innerFirstGit = false, bool outerFirstGit = false, bool topRepo = false, List<String> exclude = const [], List<String> excludeProjects = const [], List<String> recursionExclude = const [], List<String> modules = const [], bool noSkip = false, List<String> modes = const []})

Properties

bareRoot → bool

True if bare -R was used (without path argument).

final

buildOrder → bool

Sort projects in dependency build order.

final

exclude → List<String>

Exclude patterns (path-based globs).

final

excludeDev → bool

Exclude dev_dependencies from build-order sorting.

final

excludeProjects → List<String>

Exclude projects by name or path.

final

executionMode → ExecutionMode

Determines the execution mode based on parsed arguments.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

innerFirstGit → bool

Scan git repos, process innermost (deepest) first.

final

isProjectMode → bool

Returns true if in project mode.

no setter

isWorkspaceMode → bool

Returns true if in workspace mode.

no setter

modes → List<String>

Active modes for configuration processing.

final

modules → List<String>

Include only projects within specified git modules (comma-separated).

final

noSkip → bool

Ignore skip markers (tom_skip.yaml, *_skip.yaml).

final

outerFirstGit → bool

Scan git repos, process outermost (shallowest) first.

final

project → String?

Specific project(s) to run on.

final

recursionExclude → List<String>

Exclude patterns during recursive scan.

final

recursive → bool

Scan directories recursively.

final

recursiveExplicitlySet → bool

True if recursive flag was explicitly set by user (--recursive or --no-recursive).

final

root → String?

Workspace root path (from -R <path>).

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scan → String?

Scan directory for projects.

final

topRepo → bool

Find topmost git repo by traversing up from current directory.

final

workspaceRecursion → bool

Shell out to sub-workspaces instead of skipping.

final

Methods

copyWith({String? scan, bool? recursive, bool? recursiveExplicitlySet, bool? buildOrder, bool? excludeDev, String? project, String? root, bool? bareRoot, bool? workspaceRecursion, bool? innerFirstGit, bool? outerFirstGit, bool? topRepo, List<String>? exclude, List<String>? excludeProjects, List<String>? recursionExclude, List<String>? modules, bool? noSkip, List<String>? modes}) → WorkspaceNavigationArgs

Create a copy with modified values.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toArgs({String? rootPath, Set<String> suppress = const {}}) → List<String>

Convert navigation args back to command-line arguments.

toString() → String

A string representation of this object.

override

withDefaults() → WorkspaceNavigationArgs

Apply default scanning behavior.

Operators

operator ==(Object other) → bool

The equality operator.

inherited