Module utils

Module utils 

Source
Expand description

Shared utilities for rumdl, including document structure analysis, code block handling, regex helpers, and string extensions. Provides reusable traits and functions for rule implementations and core linter logic.

Re-exports§

pub use code_block_utils::CodeBlockUtils;
pub use line_ending::LineEnding;
pub use line_ending::detect_line_ending;
pub use line_ending::detect_line_ending_enum;
pub use line_ending::ensure_consistent_line_endings;
pub use line_ending::get_line_ending_str;
pub use line_ending::normalize_line_ending;
pub use markdown_elements::ElementQuality;
pub use markdown_elements::ElementType;
pub use markdown_elements::MarkdownElement;
pub use markdown_elements::MarkdownElements;
pub use range_utils::LineIndex;

Modules§

anchor_styles
Anchor generation styles for different Markdown platforms
code_block_utils
Utility functions for detecting and handling code blocks and code spans in Markdown for rumdl.
early_returns
Fast-path checks and early return utilities for rule implementations in rumdl. Provides helpers to quickly skip rules based on content analysis.
element_cache
emphasis_utils
fix_utils
Utilities for applying fixes consistently between CLI and LSP
header_id_utils
Utilities for extracting custom header IDs from various Markdown flavors
jinja_utils
kramdown_utils
Utilities for handling Kramdown-specific syntax
line_ending
markdown_elements
mkdocs_abbreviations
mkdocs_admonitions
mkdocs_attr_list
mkdocs_common
mkdocs_critic
mkdocs_definition_lists
MkDocs/Python-Markdown Definition Lists extension support
mkdocs_extensions
mkdocs_footnotes
mkdocs_icons
mkdocs_patterns
mkdocs_snippets
mkdocs_tabs
mkdocs_test_utils
mkdocstrings_refs
quarto_divs
Quarto div and callout block detection utilities
range_utils
Utilities for position/range conversions
regex_cache
Cached Regex Patterns and Fast Content Checks for Markdown Linting
sentence_utils
Sentence detection utilities
skip_context
Utilities for determining if a position in markdown should be skipped from processing
string_interner
table_utils
text_reflow
Text reflow utilities for MD013
utf8_offsets
UTF-8 byte offset to character offset conversion utilities.

Traits§

StrExt
Trait for string-related extensions

Functions§

fast_hash
Fast hash function for string content
is_definition_list_item
Check if a line is a definition list item (Extended Markdown)