Struct Config 

pub struct Config {
    pub extends: Option<String>,
    pub global: GlobalConfig,
    pub per_file_ignores: BTreeMap<String, Vec<String>>,
    pub per_file_flavor: IndexMap<String, MarkdownFlavor>,
    pub code_block_tools: CodeBlockToolsConfig,
    pub rules: BTreeMap<String, RuleConfig>,
    pub withheld_rule_values: BTreeSet<String>,
    pub project_root: Option<PathBuf>,
    /* private fields */
}

Represents the complete configuration loaded from rumdl.toml

Fields

extends: Option<String>

Path to a base config file to inherit settings from. Supports relative paths, absolute paths, ~/ for the home directory, and $VAR / ${VAR} environment-variable expansion (a literal $ is written $$). Example: extends = "../base.rumdl.toml" or extends = "$GEM_PATH/base.rumdl.toml"

global: GlobalConfig

Global configuration options

per_file_ignores: BTreeMap<String, Vec<String>>

Per-file rule ignores: maps file patterns to lists of rules to ignore. Patterns are relative to the project root; a leading ~/ expands to the home directory and absolute paths are matched as written. Example: { “README.md”: [“MD033”], “docs/**/*.md”: [“MD013”] }

per_file_flavor: IndexMap<String, MarkdownFlavor>

Per-file flavor overrides: maps file patterns to Markdown flavors. Patterns are relative to the project root; a leading ~/ expands to the home directory and absolute paths are matched as written. Example: { “docs//*.md”: MkDocs, “/*.mdx”: MDX } Uses IndexMap to preserve config file order for “first match wins” semantics

code_block_tools: CodeBlockToolsConfig

Code block tools configuration for per-language linting and formatting using external tools like ruff, prettier, shellcheck, etc.

rules: BTreeMap<String, RuleConfig>

Rule-specific configurations (e.g., MD013, MD007, MD044) Each rule section can contain options specific to that rule.

Common examples:

• MD013: line_length, code_blocks, tables, headings
• MD007: indent
• MD003: style (“atx”, “atx-closed”, “setext”)
• MD044: names (array of proper names to check)

See https://github.com/rvben/rumdl for full rule documentation.

withheld_rule_values: BTreeSet<String>

Rules holding at least one option value that came from a config file whose contents may not be quoted back (an extends target, whose path is arbitrary and whose text the extending project need not be able to read). The values apply as written; only a message about one has to leave it out.

Granularity is the rule section, because that is what a rule’s options are deserialized as: an error names one value but not which key it came from, so a section mixing an extended value with a directly named one withholds both. Erring that way keeps a message from carrying text the project never wrote.

Provenance rather than configuration, so it stays out of the serialized form and the JSON schema.

project_root: Option<PathBuf>

Project root directory, used for resolving relative paths in per-file-ignores

Implementations

impl Config

pub fn is_mkdocs_flavor(&self) -> bool

Check if the Markdown flavor is set to MkDocs

pub fn markdown_flavor(&self) -> MarkdownFlavor

Get the configured Markdown flavor

pub fn is_mkdocs_project(&self) -> bool

Legacy method for backwards compatibility - redirects to is_mkdocs_flavor

pub fn apply_per_rule_enabled(&mut self)

Apply per-rule enabled config to the global enable/disable lists.

For [MD060] enabled = true: adds the rule to extend_enable and removes it from disable and extend_disable, ensuring the rule is active.

For [MD041] enabled = false: adds the rule to disable and removes it from extend_enable, ensuring the rule is inactive.

Per-rule enabled takes precedence over global lists when there is a conflict, since it represents a more specific intent.

pub fn get_rule_severity(&self, rule_name: &str) -> Option<Severity>

Get the severity override for a specific rule, if configured

pub fn get_ignored_rules_for_file(&self, file_path: &Path) -> HashSet<String>

Get the set of rules that should be ignored for a specific file based on per-file-ignores configuration Returns a HashSet of rule names (uppercase, e.g., “MD033”) that match the given file path

pub fn get_flavor_for_file(&self, file_path: &Path) -> MarkdownFlavor

Get the MarkdownFlavor for a specific file based on per-file-flavor configuration. Returns the first matching pattern’s flavor, or falls back to global flavor, or auto-detects from extension, or defaults to Standard.

pub fn canonicalize_rule_lists(&mut self)

Canonicalize every rule-name list inside this Config.

This is the single enforcement point for the runtime invariant: after a Config is fully built, every rule-name list contains canonical rule IDs ("MD033") — never aliases ("no-inline-html").

The invariant lets every consumer (rules::filter_rules, the LSP, WASM, fix coordinator, per-file-ignore lookups) match against Rule::name() with simple string equality. Mutation boundaries (From<SourcedConfig> for Config, LSP apply_lsp_settings_*, WASM to_config_with_warnings) call this before handing the Config to the linting pipeline.

Covers global.{enable,disable,extend_enable,extend_disable,fixable,unfixable} and the values of per_file_ignores. Idempotent.

pub fn merge_with_inline_config(&self, inline_config: &InlineConfig) -> Self

Merge inline configuration overrides into a copy of this config

This enables automatic inline config support - the engine can merge inline overrides and recreate rules without any per-rule changes.

Returns a new Config with the inline overrides merged in. If there are no inline overrides, returns a clone of self.

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() -> Config

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 From<SourcedConfig<ConfigValidated>> for Config

Convert a validated configuration to the final Config type.

This implementation only exists for SourcedConfig<ConfigValidated>, ensuring that validation must occur before conversion.

fn from(sourced: SourcedConfig<ConfigValidated>) -> Self

Converts to this type from the input type.

impl JsonSchema for Config

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 Config

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

Equality operator ==.

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

Inequality operator !=.

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.