Struct GlobalConfig 

pub struct GlobalConfig {

    pub enable: Vec<String>,
    pub disable: Vec<String>,
    pub exclude: Vec<String>,
    pub include: Vec<String>,
    pub respect_gitignore: bool,
    pub line_length: LineLength,
    pub output_format: Option<String>,
    pub fixable: Vec<String>,
    pub unfixable: Vec<String>,
    pub flavor: MarkdownFlavor,
    pub force_exclude: bool,
    pub cache_dir: Option<String>,
    pub cache: bool,
    pub extend_enable: Vec<String>,
    pub extend_disable: Vec<String>,
    pub editorconfig: bool,
    pub enable_is_explicit: bool,
    pub include_withheld: Option<String>,
}

Global configuration options

Fields

enable: Vec<String>

Enabled rules

disable: Vec<String>

Disabled rules

exclude: Vec<String>

Files to exclude. Glob patterns, relative to the project root; a leading ~/ expands to the home directory and absolute paths are matched as written.

include: Vec<String>

Files to include. Glob patterns, relative to the project root; a leading ~/ expands to the home directory and absolute paths are matched as written.

respect_gitignore: bool

Respect .gitignore files when scanning directories

line_length: LineLength

Global line length setting (used by MD013 and other rules if not overridden)

output_format: Option<String>

Output format for linting results (e.g., “text”, “json”, “pylint”, etc.)

fixable: Vec<String>

Rules that are allowed to be fixed when –fix is used If specified, only these rules will be fixed

unfixable: Vec<String>

Rules that should never be fixed, even when –fix is used Takes precedence over fixable

flavor: MarkdownFlavor

Markdown flavor/dialect to use (mkdocs, gfm, commonmark, etc.) When set, adjusts parsing and validation rules for that specific Markdown variant

force_exclude: bool

👎Deprecated since 0.0.156:

Exclude patterns are now always respected

[DEPRECATED] Whether to enforce exclude patterns for explicitly passed paths. This option is deprecated as of v0.0.156 and has no effect. Exclude patterns are now always respected, even for explicitly provided files. This prevents duplication between rumdl config and tool configs like pre-commit.

cache_dir: Option<String>

Directory to store cache files (default: .rumdl_cache). A leading ~/ expands to the home directory; a relative path resolves against the project root. Can also be set via –cache-dir CLI flag or RUMDL_CACHE_DIR environment variable

cache: bool

Whether caching is enabled (default: true) Can also be disabled via –no-cache CLI flag

extend_enable: Vec<String>

Additional rules to enable on top of the base set (additive)

extend_disable: Vec<String>

Additional rules to disable on top of the base set (additive)

editorconfig: bool

Whether to read settings from .editorconfig files (default: false). When enabled, the .editorconfig properties that map onto rumdl settings fill in anything no rumdl config sets, resolved per file so section globs and nested .editorconfig files apply as written.

enable_is_explicit: bool

Whether the enable list was explicitly set (even if empty). Used to distinguish “no enable list configured” from “enable list is empty” (e.g., markdownlint default: false with no rules enabled).

include_withheld: Option<String>

How to name the file that supplied Self::include when a message about those patterns may not quote them (an extends target, whose path is arbitrary and whose text the extending project need not be able to read), and None when it may. Provenance rather than configuration, so it stays out of the serialized form and the JSON schema.

Implementations

impl GlobalConfig

pub fn canonicalize_rule_lists(&mut self)

Canonicalize every rule-name list in this GlobalConfig.

Rewrites enable, disable, extend_enable, extend_disable, fixable, and unfixable so that all entries are canonical rule IDs ("MD033") rather than aliases ("no-inline-html"). Duplicates are removed, preserving first-occurrence order; the special "all" keyword is preserved.

This must be called by every code path that mutates a runtime Config’s rule lists from external input (markdownlint configs, .rumdl.toml, LSP initializationOptions, WASM bindings, etc.) so that downstream consumers (rules::filter_rules, the LSP, WASM) can match against Rule::name() with simple string equality.

Trait Implementations

impl Clone for GlobalConfig

fn clone(&self) -> GlobalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalConfig

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

Formats the value using the given formatter.

impl Default for GlobalConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GlobalConfig

where GlobalConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GlobalConfig

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 PartialEq for GlobalConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GlobalConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GlobalConfig