Expand description
Portable protocol types for Morphir workspace discovery.
Modules§
- config
- Pure configuration candidate discovery over a portable file tree.
Structs§
- Discovery
Failure - A fatal, provider-neutral workspace discovery failure.
- Discovery
Request - A complete, provider-independent request for workspace discovery.
- File
Tree - A deterministic collection of canonical paths and their entries.
- Project
Snapshot - A deterministic, provider-neutral snapshot of a project.
- Relative
Path - A canonical slash-separated path confined beneath a named mount.
- Source
Selection - Which sources a request selects, and the root they are measured from.
- Version
- SemVer version as defined by https://semver.org.
- Workspace
Diagnostic - A provider-neutral diagnostic emitted during workspace discovery.
- Workspace
Discovery Details - In-memory discovery details for native hosts that need the exact effective configuration values produced by the portable discovery pass.
- Workspace
Snapshot - A deterministic, provider-neutral snapshot of a workspace.
Enums§
- Diagnostic
Severity - The severity of a workspace discovery diagnostic.
- Discovery
Purpose - What a discovery request is asking for.
- Discovery
Response - The provider-neutral result of workspace discovery.
- File
Entry - An entry in a portable, root-confined file tree.
- Project
Origin - Where a discovered project came from.
- Project
Source - Where a request’s project identity comes from.
- Project
State - The state of a discovered project.
- Relative
Path Error - An error returned when a path is not confined to its named mount.
- Workspace
State - The state of a discovered workspace.
Constants§
- WORKSPACE_
CONFIG_ AMBIGUOUS - Stable diagnostic code for ambiguous workspace configurations.
- WORKSPACE_
CONFIG_ INVALID - Stable diagnostic code for an invalid workspace configuration.
- WORKSPACE_
CONFIG_ MISSING - Stable diagnostic code for a missing workspace configuration.
- WORKSPACE_
DISCOVERY_ PROTOCOL - The workspace discovery protocol version this build writes.
- WORKSPACE_
LANGUAGE_ ID_ EMPTY - Stable diagnostic code for an ad-hoc request with an empty language id.
- WORKSPACE_
MEMBER_ DUPLICATE_ NAME - Stable diagnostic code for duplicate workspace member names.
- WORKSPACE_
MEMBER_ INVALID - Stable diagnostic code for an invalid workspace member.
- WORKSPACE_
PATH_ NOT_ CONFINED - Stable diagnostic code for a path that escapes its named mount.
- WORKSPACE_
PROJECT_ NAME_ EMPTY - Stable diagnostic code for an explicit CLI overlay project name that is empty or whitespace-only.
- WORKSPACE_
PROJECT_ NAME_ INVALID - Stable diagnostic code for an explicit project name that the selected provider’s package contract rejects.
- WORKSPACE_
PROTOCOL_ UNSUPPORTED - Stable diagnostic code for an unsupported discovery protocol version.
- WORKSPACE_
PURPOSE_ UNSUPPORTED - Stable diagnostic code for a discovery purpose this build does not implement.
- WORKSPACE_
SELECTION_ DUPLICATE - Stable diagnostic code for an ad-hoc source selection with a repeated path.
- WORKSPACE_
SELECTION_ EMPTY - Stable diagnostic code for an ad-hoc source selection with no paths.
- WORKSPACE_
SELECTION_ INVALID - Stable diagnostic code for an ad-hoc selected path that is not a file.
- WORKSPACE_
SELECTION_ MODULE_ COLLISION - Stable diagnostic code for two selected sources that a provider derives the same module name from.
- WORKSPACE_
SELECTION_ NAME_ REQUIRED - Stable diagnostic code for an unnamed ad-hoc selection that selects more than one source, and therefore has nothing a provider could derive a name from.
- WORKSPACE_
SELECTION_ OUTSIDE_ ROOT - Stable diagnostic code for an ad-hoc selected path outside its selection root.
- WORKSPACE_
SYMLINK_ UNSUPPORTED - Stable diagnostic code for a symlink that a protocol-v1 host did not materialize.
Traits§
- Source
Identity - How one language turns selected sources into package and module identity.
Functions§
- discover
- Discovers a Morphir workspace from portable, root-confined inputs.
- discover_
with_ details - Discovers a workspace and returns the exact merged configuration values
produced by the same pass as
discover. - discover_
with_ identity - Discovers a workspace and completes an ad-hoc project with
identity. - speaks_
workspace_ discovery_ protocol - Whether this build speaks workspace discovery protocol
version. - workspace_
discovery_ protocol WORKSPACE_DISCOVERY_PROTOCOLas a version.