Struct MD044ProperNames 

pub struct MD044ProperNames { /* private fields */ }

Rule MD044: Proper names should be capitalized

See docs/md044.md for full documentation, configuration, and examples.

This rule is triggered when proper names are not capitalized correctly in the document. For example, if you have defined “JavaScript” as a proper name, the rule will flag any occurrences of “javascript” or “Javascript” as violations.

Purpose

Ensuring consistent capitalization of proper names improves document quality and professionalism. This is especially important for technical documentation where product names, programming languages, and technologies often have specific capitalization conventions.

Configuration Options

The rule supports the following configuration options:

MD044:
  names: []                # List of proper names to check for correct capitalization
  code_blocks_excluded: true  # Whether to exclude code blocks from checking

Example configuration:

MD044:
  names: ["JavaScript", "Node.js", "TypeScript"]
  code_blocks_excluded: true

Performance Optimizations

This rule implements several performance optimizations:

1. Regex Caching: Pre-compiles and caches regex patterns for each proper name
2. Content Caching: Caches results based on content hashing for repeated checks
3. Efficient Text Processing: Uses optimized algorithms to avoid redundant text processing
4. Smart Code Block Detection: Efficiently identifies and optionally excludes code blocks

Edge Cases Handled

• Word Boundaries: Only matches complete words, not substrings within other words
• Case Sensitivity: Properly handles case-specific matching
• Code Blocks: Optionally excludes code blocks where capitalization may be intentionally different
• Markdown Formatting: Handles proper names within Markdown formatting elements

Fix Behavior

When fixing issues, this rule replaces incorrect capitalization with the correct form as defined in the configuration.

Implementations

impl MD044ProperNames

pub fn new(names: Vec<String>, code_blocks: bool) -> Self

pub fn from_config_struct(config: MD044Config) -> Self

Trait Implementations

impl Clone for MD044ProperNames

fn clone(&self) -> MD044ProperNames

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Rule for MD044ProperNames

fn name(&self) -> &'static str

fn description(&self) -> &'static str

fn should_skip(&self, ctx: &LintContext<'_>) -> bool

Check if this rule should quickly skip processing based on content

fn check(&self, ctx: &LintContext<'_>) -> LintResult

fn fix(&self, ctx: &LintContext<'_>) -> Result<String, LintError>

fn as_any(&self) -> &dyn Any

fn default_config_section(&self) -> Option<(String, Value)>

Returns the rule name and default config table if the rule has config. If a rule implements this, it MUST be defined on the impl Rule for ... block, not just the inherent impl.

fn from_config(config: &Config) -> Box<dyn Rule>

where Self: Sized,

Factory: create a rule from config (if present), or use defaults.

fn check_with_structure( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, ) -> LintResult

Enhanced check method using document structure By default, calls the regular check method if not overridden

fn check_with_ast( &self, ctx: &LintContext<'_>, _ast: &MarkdownAst, ) -> LintResult

AST-based check method for rules that can benefit from shared AST parsing By default, calls the regular check method if not overridden

fn check_with_structure_and_ast( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, _ast: &MarkdownAst, ) -> LintResult

Combined check method using both document structure and AST By default, calls the regular check method if not overridden

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

fn uses_ast(&self) -> bool

Check if this rule can benefit from AST parsing

fn uses_document_structure(&self) -> bool

Check if this rule can benefit from document structure

fn as_maybe_document_structure(&self) -> Option<&dyn MaybeDocumentStructure>

fn as_maybe_ast(&self) -> Option<&dyn MaybeAst>

fn config_aliases(&self) -> Option<HashMap<String, String>>

Returns config key aliases for this rule This allows rules to accept alternative config key names for backwards compatibility

fn fix_capability(&self) -> FixCapability

Declares the fix capability of this rule