Struct Config 

pub struct Config {
    pub engines: EngineConfig,
    pub rules: HashMap<String, RuleConfig>,
    pub exclude: Vec<String>,
    pub auto_fix: Vec<AutoFixRule>,
    pub performance: PerformanceConfig,
    pub dictionaries: DictionaryConfig,
    pub languages: LanguageConfig,
    pub workspace: WorkspaceConfig,
    pub names: NameConfig,
    pub morphology: MorphologyConfig,
}

Fields

engines: EngineConfig

rules: HashMap<String, RuleConfig>

exclude: Vec<String>

auto_fix: Vec<AutoFixRule>

performance: PerformanceConfig

dictionaries: DictionaryConfig

languages: LanguageConfig

workspace: WorkspaceConfig

names: NameConfig

morphology: MorphologyConfig

Implementations

impl Config

pub fn load_or_warn(workspace_root: &Path) -> Self

Load configuration, warning and falling back to defaults if it cannot be read.

load fails on a malformed .languagecheck.yaml — a bad indent, a typo’d enum — and callers used to answer that with a bare Config::default(), so a rejected file was indistinguishable from an absent one and the user’s overrides silently did nothing. A missing file is not an error and is not reported; an unreadable one is.

Callers with no tracing subscriber installed (the CLI binary) must report to stderr themselves rather than call this, or the warning goes nowhere.

pub fn excludes(&self, path: &Path, workspace_root: &Path) -> bool

Whether exclude covers this path.

path may be absolute or already relative to workspace_root; it is reduced to the workspace-relative form the patterns are written against, because node_modules/** is how a user thinks about it and an absolute path would never match.

An unparseable pattern excludes nothing. Refusing to check a file because a glob had a typo is the worse of the two failures.

pub fn load(workspace_root: &Path) -> Result<Self>

pub fn apply_auto_fixes(&self, text: &str) -> (String, usize)

Apply user-defined auto-fix rules to the given text, returning the modified text and the number of replacements made.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.