Struct WorkspaceDiagnostic 

pub struct WorkspaceDiagnostic {
    pub path: PathBuf,
    pub kind: WorkspaceDiagnosticKind,
    pub message: String,
    pub degrades_analysis: bool,
}

A diagnostic about a workspace-discovery candidate.

The message field is a human-readable rendering derived from kind. It always ends with a concrete next step (“fix the JSON syntax”, “remove from workspaces”, “add to ignorePatterns”) so first-time users have a path forward.

Fields

path: PathBuf

Path to the directory or file that triggered the diagnostic.

kind: WorkspaceDiagnosticKind

Kind discriminator with the typed payload.

message: String

Human-readable rendering derived from kind + path. Always ends with a next-step hint.

degrades_analysis: bool

True when this diagnostic reports a run whose RESULTS are degraded: something the user installed, wrote, or expected did not reach the analysis. Projected from WorkspaceDiagnosticKind::warns_on_stderr, which is the same classification that decides whether the CLI prints a stderr line, so a CI log built from this field and a local non-quiet run say the same thing.

Omitted when false, which is what keeps every clean run byte-identical. The two unconfigured-check kinds answer false on purpose: they fire in the product’s default state on every project that never opted into boundaries or rule packs, so warning on them would warn forever. So does excluded-by-default-ignore, which is designed behavior on generated output; the alarm for that case is no-source-files-analyzed.

Read this instead of hardcoding a kind allowlist: a degrading kind added in a later release then reaches an unchanged consumer.

Implementations

impl WorkspaceDiagnostic

pub fn new( root: &Path, path: PathBuf, kind: WorkspaceDiagnosticKind, ) -> WorkspaceDiagnostic

Construct a diagnostic with the message rendered from kind + path.

root is used to produce project-relative paths in the message text AND inside the variant payload (e.g. the error field of MalformedPackageJson / MalformedTsconfig which embed the absolute file path from PackageJson::load()’s error text). Without the payload-side normalisation the embedded path would survive environment-specific differences (CI vs Docker vs local) because the post-serialisation strip_root_prefix only catches whole-string matches, not paths embedded mid-sentence.

If path is not under root (e.g. canonicalisation crossed a symlink), the absolute path is emitted instead.

path also loses any no-op . component, for the same reason the payload loses a glob’s ./ prefix: one directory reached through two spellings of one glob must be one diagnostic.

pub fn into_root_relative(self, root: &Path) -> WorkspaceDiagnostic

Return this diagnostic with path rewritten relative to root.

path is stored absolute so callers can act on it. Every JSON envelope emits it project-relative instead: the analysis envelopes get there through the post-serialisation strip_root_prefix pass, which the fallow workspaces / fallow list --workspaces envelope and the MCP project_info tool never run, so those emitted the absolute path while the sibling workspaces[].path next to it was relative. They normalise at the typed layer with this method instead.

Paths outside root (canonicalisation crossed a symlink) are left absolute, matching how Self::new renders the message.

A diagnostic anchored at the root itself becomes ., not the empty path: an empty string is not a location, and the analysis envelopes’ post-serialisation strip only removes a root + separator prefix, so a root-anchored path that stays absolute here leaks a host path.

Trait Implementations

impl Clone for WorkspaceDiagnostic

fn clone(&self) -> WorkspaceDiagnostic

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkspaceDiagnostic

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkspaceDiagnostic

fn deserialize<__D>( __deserializer: __D, ) -> Result<WorkspaceDiagnostic, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WorkspaceDiagnostic

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for WorkspaceDiagnostic

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.