Skip to main content

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 parser_options::rumdl_parser_options;
pub use range_utils::LineIndex;

Modules§

anchor_styles
Anchor generation styles for different Markdown platforms
atomic_write
Atomic file writes for the --fix / fmt path.
blockquote
Blockquote-related utilities for rumdl.
code_block_utils
Utility functions for detecting and handling code blocks and code spans in Markdown for rumdl.
emphasis_utils
fix_utils
Utilities for applying fixes consistently between CLI and LSP
frontmatter_values
Reading values out of a document’s frontmatter.
header_id_utils
Utilities for extracting custom header IDs from various Markdown flavors
html_block
Shared HTML block-start classification.
jinja_utils
kramdown_utils
Utilities for handling Kramdown-specific syntax
line_ending
mkdocs_admonitions
mkdocs_attr_list
mkdocs_common
Common utilities and constants for MkDocs pattern detection
mkdocs_config
Shared MkDocs configuration utilities.
mkdocs_critic
mkdocs_definition_lists
MkDocs/Python-Markdown Definition Lists extension support
mkdocs_extensions
MkDocs PyMdown extensions support
mkdocs_footnotes
mkdocs_html_markdown
HTML with a markdown attribute detection
mkdocs_icons
mkdocs_patterns
mkdocs_snippets
mkdocs_tabs
mkdocstrings_refs
obsidian_config
Obsidian vault configuration utilities.
pandoc
Pandoc Markdown syntax detection.
parser_options
project_root
Project root discovery for resolving project-relative paths.
pymdown_blocks
PyMdown Extensions Blocks detection utilities
quarto_chunks
Parser for Quarto / RMarkdown executable code chunk metadata.
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
table_utils
text_reflow
Text reflow utilities for MD013
thematic_break
unicode
upward_walk
Upward directory traversal with shared stop semantics.
utf8_offsets
UTF-8 byte offset to character offset conversion utilities.

Traits§

StrExt
Trait for string-related extensions

Functions§

calculate_indentation_width
Calculate the visual indentation width of a string, expanding tabs to spaces.
calculate_indentation_width_default
Calculate the visual indentation width using default tab width of 4
fast_hash
Fast hash function for string content
is_definition_list_item
Check if a line is a definition list item (Extended Markdown)
is_template_directive_only
Check if a line consists only of a template directive with no surrounding text.