Struct PluginConfigDiagnostic 

pub struct PluginConfigDiagnostic {
    pub config_path: PathBuf,
    pub plugin: String,
    pub key: String,
    pub reason: String,
    pub effect: PluginConfigEffect,
}

One advisory about a config file a plugin read, before it becomes a fallow_config::WorkspaceDiagnostic.

A plugin knows the fact (which config file, which key, why) but not the root the message renders against: in a workspace run its own root is the package root, while the diagnostic’s path and message are project-root-relative. The conversion therefore happens once, where every plugin result has converged on the project root, and config_path is kept ABSOLUTE until then so the registry’s canonical dedupe and the serialized root-relative form both work from one value (issue #2736).

Fields

config_path: PathBuf

Absolute path of the config file that was read.

plugin: String

The plugin that read it, as it labels itself. Module Federation options reach four bundler plugins inline, and each names itself rather than the reader, because the config file the user must edit is the bundler’s.

key: String

The config key the advisory is about (exposes, remotes, components, imports).

reason: String

Why, as a kebab-case token from the resulting kind’s open set.

effect: PluginConfigEffect

Which workspace diagnostic kind this becomes.

Implementations

impl PluginConfigDiagnostic

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

Render this advisory against the PROJECT root, which is the root every consumer’s paths are relative to.

Trait Implementations

impl Clone for PluginConfigDiagnostic

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginConfigDiagnostic

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

Formats the value using the given formatter.

impl Eq for PluginConfigDiagnostic

impl PartialEq for PluginConfigDiagnostic

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PluginConfigDiagnostic