pub struct Config {
pub global: GlobalConfig,
pub per_file_ignores: HashMap<String, Vec<String>>,
pub rules: BTreeMap<String, RuleConfig>,
}Expand description
Represents the complete configuration loaded from rumdl.toml
Fields§
§global: GlobalConfigGlobal configuration options
per_file_ignores: HashMap<String, Vec<String>>Per-file rule ignores: maps file patterns to lists of rules to ignore Example: { “README.md”: [“MD033”], “docs/**/*.md”: [“MD013”] }
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.
Implementations§
Source§impl Config
impl Config
Sourcepub fn is_mkdocs_flavor(&self) -> bool
pub fn is_mkdocs_flavor(&self) -> bool
Check if the Markdown flavor is set to MkDocs
Sourcepub fn markdown_flavor(&self) -> MarkdownFlavor
pub fn markdown_flavor(&self) -> MarkdownFlavor
Get the configured Markdown flavor
Sourcepub fn is_mkdocs_project(&self) -> bool
pub fn is_mkdocs_project(&self) -> bool
Legacy method for backwards compatibility - redirects to is_mkdocs_flavor
Sourcepub fn get_ignored_rules_for_file(&self, file_path: &Path) -> HashSet<String>
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
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Config
impl<'de> Deserialize<'de> for Config
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl From<SourcedConfig> for Config
impl From<SourcedConfig> for Config
Source§fn from(sourced: SourcedConfig) -> Self
fn from(sourced: SourcedConfig) -> Self
Source§impl JsonSchema for Config
impl JsonSchema for Config
Source§fn schema_name() -> String
fn schema_name() -> String
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
$ref keyword. Read moreimpl StructuralPartialEq for Config
Auto Trait Implementations§
impl Freeze for Config
impl RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more