rumdl 0.0.162__tar.gz → 0.0.163__tar.gz

{rumdl-0.0.162 → rumdl-0.0.163}/CHANGELOG.md

@@ -7,6 +7,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.163] - 2025-10-20
+
+### Changed
+
+- **MD024**: Default `siblings_only` to true for better usability
+  - Multiple headings with same text now only flagged if they're direct siblings
+  - Reduces false positives in documents with common section headings
+  - More intuitive default behavior matching common use cases
+
+### Fixed
+
+- **MD013**: Enforce line length in sentence_per_line mode (fixes #111)
+  - Previously, sentence_per_line mode completely ignored line_length setting
+  - Now warns about single sentences exceeding configured line_length
+  - No auto-fix for long single sentences (requires manual rephrasing)
+  - Still auto-fixes multi-sentence lines by splitting on sentence boundaries
+  - Cleaned up warning messages by removing verbose parentheticals
+  - Maintains semantic integrity (won't split mid-sentence) while respecting configured line_length
+
+- **HTML Comments**: Complete fix to ignore all content inside HTML comments (fixes #119, #20)
+  - All rules now properly ignore content within HTML comment blocks (`<!-- ... -->`)
+  - Added `in_html_comment` field to `LineInfo` for comprehensive tracking
+  - Extended filtered lines API with `skip_html_comments()` method
+  - Updated MD013, MD049, and other rules to skip HTML comment content
+  - Prevents false positives from commented-out markdown (MD013, MD049, MD005, MD006, MD039, MD042)
+  - Better handling of multi-line HTML comments across all linting rules
+
+- **MD046**: Resolve false positives from Issue #118
+  - Fixed incorrect flagging of valid code block syntax
+  - Improved code block style detection accuracy
+
+- **MD050**: Resolve false positives from Issue #118
+  - Fixed incorrect strong style detection in edge cases
+  - Better handling of emphasis patterns
+
+- **Tests**: Fixed sentence_per_line_detection test assertion
+  - Updated test to match simplified warning message from MD013
+  - Test was expecting verbose message after message was simplified in earlier commit
+
 ## [0.0.162] - 2025-10-16
 
 ### Added
@@ -1108,7 +1147,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial implementation of remaining rules for markdownlint parity
 
-[Unreleased]: https://github.com/rvben/rumdl/compare/v0.0.144...HEAD
+[Unreleased]: https://github.com/rvben/rumdl/compare/v0.0.163...HEAD
+[0.0.163]: https://github.com/rvben/rumdl/compare/v0.0.162...v0.0.163
+[0.0.162]: https://github.com/rvben/rumdl/compare/v0.0.161...v0.0.162
+[0.0.161]: https://github.com/rvben/rumdl/compare/v0.0.160...v0.0.161
+[0.0.160]: https://github.com/rvben/rumdl/compare/v0.0.159...v0.0.160
+[0.0.159]: https://github.com/rvben/rumdl/compare/v0.0.158...v0.0.159
+[0.0.158]: https://github.com/rvben/rumdl/compare/v0.0.157...v0.0.158
+[0.0.157]: https://github.com/rvben/rumdl/compare/v0.0.156...v0.0.157
+[0.0.156]: https://github.com/rvben/rumdl/compare/v0.0.155...v0.0.156
+[0.0.155]: https://github.com/rvben/rumdl/compare/v0.0.154...v0.0.155
+[0.0.154]: https://github.com/rvben/rumdl/compare/v0.0.153...v0.0.154
+[0.0.153]: https://github.com/rvben/rumdl/compare/v0.0.152...v0.0.153
+[0.0.152]: https://github.com/rvben/rumdl/compare/v0.0.151...v0.0.152
+[0.0.151]: https://github.com/rvben/rumdl/compare/v0.0.150...v0.0.151
+[0.0.150]: https://github.com/rvben/rumdl/compare/v0.0.149...v0.0.150
+[0.0.149]: https://github.com/rvben/rumdl/compare/v0.0.148...v0.0.149
+[0.0.148]: https://github.com/rvben/rumdl/compare/v0.0.147...v0.0.148
+[0.0.147]: https://github.com/rvben/rumdl/compare/v0.0.146...v0.0.147
+[0.0.146]: https://github.com/rvben/rumdl/compare/v0.0.145...v0.0.146
+[0.0.145]: https://github.com/rvben/rumdl/compare/v0.0.144...v0.0.145
 [0.0.144]: https://github.com/rvben/rumdl/compare/v0.0.143...v0.0.144
 [0.0.142]: https://github.com/rvben/rumdl/compare/v0.0.141...v0.0.142
 [0.0.140]: https://github.com/rvben/rumdl/compare/v0.0.139...v0.0.140

{rumdl-0.0.162 → rumdl-0.0.163}/Cargo.lock

@@ -1952,7 +1952,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.162"
+version = "0.0.163"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.162 → rumdl-0.0.163}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.162"
+version = "0.0.163"
 edition = "2024"
 rust-version = "1.89.0"
 description = "A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)"

{rumdl-0.0.162 → rumdl-0.0.163}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.162
+Version: 0.0.163
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -172,6 +172,19 @@ uv tool install rumdl
 uv tool run rumdl check .
 ```
 
+### Using Nix (macOS/Linux)
+
+```bash
+nix-channel --update
+nix-env --install --attr nixpkgs.rumdl
+```
+
+Alternatively, you can use flakes to run it without installation.
+
+```bash
+nix run --extra-experimental-features 'flakes nix-command' nixpkgs/nixpkgs-unstable#rumdl -- --version
+```
+
 ### Download binary
 
 ```bash

{rumdl-0.0.162 → rumdl-0.0.163}/README.md

@@ -143,6 +143,19 @@ uv tool install rumdl
 uv tool run rumdl check .
 ```
 
+### Using Nix (macOS/Linux)
+
+```bash
+nix-channel --update
+nix-env --install --attr nixpkgs.rumdl
+```
+
+Alternatively, you can use flakes to run it without installation.
+
+```bash
+nix run --extra-experimental-features 'flakes nix-command' nixpkgs/nixpkgs-unstable#rumdl -- --version
+```
+
 ### Download binary
 
 ```bash

{rumdl-0.0.162 → rumdl-0.0.163}/docs/md024.md

@@ -73,12 +73,15 @@ How to run the test suite...
 
 ## Configuration
 
-```yaml
-MD024:
-  allow-different-nesting: false  # Allow duplicates at different levels (default: false)
-  siblings-only: false           # Only check siblings at same level (default: false)
+```toml
+[MD024]
+allow-different-nesting = false  # Allow duplicates at different levels (default: false)
+siblings-only = true             # Only check siblings at same level (default: true)
 ```
 
+**Note:** rumdl defaults `siblings-only` to `true` (unlike markdownlint's `false` ) to reduce false positives in CHANGELOGs and structured documentation. To match markdownlint's stricter behavior, set
+`siblings-only = false` .
+
 ## Automatic fixes
 
 This rule cannot be automatically fixed because changing heading text requires understanding the content's meaning. You'll need to manually update duplicate headings to be more descriptive.

{rumdl-0.0.162 → rumdl-0.0.163}/src/filtered_lines.rs

@@ -55,7 +55,8 @@ pub struct FilteredLine<'a> {
 /// let config = LineFilterConfig::new()
 ///     .skip_front_matter()
 ///     .skip_code_blocks()
-///     .skip_html_blocks();
+///     .skip_html_blocks()
+///     .skip_html_comments();
 /// ```
 #[derive(Debug, Clone, Default)]
 pub struct LineFilterConfig {
@@ -65,6 +66,8 @@ pub struct LineFilterConfig {
     pub skip_code_blocks: bool,
     /// Skip lines inside HTML blocks
     pub skip_html_blocks: bool,
+    /// Skip lines inside HTML comments
+    pub skip_html_comments: bool,
 }
 
 impl LineFilterConfig {
@@ -104,11 +107,22 @@ impl LineFilterConfig {
         self
     }
 
+    /// Skip lines inside HTML comments
+    ///
+    /// HTML comments (<!-- ... -->) are metadata and should not be processed
+    /// by most markdown linting rules.
+    #[must_use]
+    pub fn skip_html_comments(mut self) -> Self {
+        self.skip_html_comments = true;
+        self
+    }
+
     /// Check if a line should be filtered out based on this configuration
     fn should_filter(&self, line_info: &LineInfo) -> bool {
         (self.skip_front_matter && line_info.in_front_matter)
             || (self.skip_code_blocks && line_info.in_code_block)
             || (self.skip_html_blocks && line_info.in_html_block)
+            || (self.skip_html_comments && line_info.in_html_comment)
     }
 }
 
@@ -245,6 +259,13 @@ impl<'a> FilteredLinesBuilder<'a> {
         self.config = self.config.skip_html_blocks();
         self
     }
+
+    /// Skip lines inside HTML comments
+    #[must_use]
+    pub fn skip_html_comments(mut self) -> Self {
+        self.config = self.config.skip_html_comments();
+        self
+    }
 }
 
 impl<'a> IntoIterator for FilteredLinesBuilder<'a> {

{rumdl-0.0.162 → rumdl-0.0.163}/src/lint_context.rs

@@ -10,25 +10,25 @@ lazy_static! {
     // Comprehensive link pattern that captures both inline and reference links
     // Use (?s) flag to make . match newlines
     static ref LINK_PATTERN: Regex = Regex::new(
-        r"(?sx)
+        r#"(?sx)
         \[((?:[^\[\]\\]|\\.|\[[^\]]*\])*)\]          # Link text in group 1 (handles nested brackets)
         (?:
-            \(([^)]*)\)       # Inline URL in group 2 (can be empty)
+            \((?:<([^<>\n]*)>|([^)"']*))(?:\s+(?:"([^"]*)"|'([^']*)'))?\)  # URL in group 2 (angle) or 3 (bare), title in 4/5
             |
-            \[([^\]]*)\]      # Reference ID in group 3
-        )"
+            \[([^\]]*)\]      # Reference ID in group 6
+        )"#
     ).unwrap();
 
     // Image pattern (similar to links but with ! prefix)
     // Use (?s) flag to make . match newlines
     static ref IMAGE_PATTERN: Regex = Regex::new(
-        r"(?sx)
+        r#"(?sx)
         !\[((?:[^\[\]\\]|\\.|\[[^\]]*\])*)\]         # Alt text in group 1 (handles nested brackets)
         (?:
-            \(([^)]*)\)       # Inline URL in group 2 (can be empty)
+            \((?:<([^<>\n]*)>|([^)"']*))(?:\s+(?:"([^"]*)"|'([^']*)'))?\)  # URL in group 2 (angle) or 3 (bare), title in 4/5
             |
-            \[([^\]]*)\]      # Reference ID in group 3
-        )"
+            \[([^\]]*)\]      # Reference ID in group 6
+        )"#
     ).unwrap();
 
     // Reference definition pattern
@@ -78,6 +78,8 @@ pub struct LineInfo {
     pub in_front_matter: bool,
     /// Whether this line is inside an HTML block
     pub in_html_block: bool,
+    /// Whether this line is inside an HTML comment
+    pub in_html_comment: bool,
     /// List item information if this line starts a list item
     pub list_item: Option<ListItemInfo>,
     /// Heading information if this line is a heading
@@ -751,7 +753,7 @@ impl<'a> LintContext<'a> {
         code_spans: &[CodeSpan],
         flavor: MarkdownFlavor,
     ) -> Vec<ParsedLink> {
-        use crate::utils::skip_context::is_mkdocs_snippet_line;
+        use crate::utils::skip_context::{is_in_html_comment, is_mkdocs_snippet_line};
 
         // Pre-size based on a heuristic: most markdown files have relatively few links
         let mut links = Vec::with_capacity(content.len() / 500); // ~1 link per 500 chars
@@ -785,6 +787,11 @@ impl<'a> LintContext<'a> {
                 continue;
             }
 
+            // Skip if in HTML comment
+            if is_in_html_comment(content, match_start) {
+                continue;
+            }
+
             // Skip if this link is on a MkDocs snippet line
             // Find which line this link is on
             let line_idx = lines
@@ -832,7 +839,10 @@ impl<'a> LintContext<'a> {
 
             let text = cap.get(1).map_or("", |m| m.as_str()).to_string();
 
-            if let Some(inline_url) = cap.get(2) {
+            // URL can be in group 2 (angle brackets) or group 3 (bare)
+            let inline_url = cap.get(2).or_else(|| cap.get(3));
+
+            if let Some(url_match) = inline_url {
                 // Inline link
                 links.push(ParsedLink {
                     line: line_num,
@@ -841,11 +851,11 @@ impl<'a> LintContext<'a> {
                     byte_offset: match_start,
                     byte_end: match_end,
                     text,
-                    url: inline_url.as_str().to_string(),
+                    url: url_match.as_str().to_string(),
                     is_reference: false,
                     reference_id: None,
                 });
-            } else if let Some(ref_id) = cap.get(3) {
+            } else if let Some(ref_id) = cap.get(6) {
                 // Reference link
                 let ref_id_str = ref_id.as_str();
                 let normalized_ref = if ref_id_str.is_empty() {
@@ -878,6 +888,8 @@ impl<'a> LintContext<'a> {
         code_blocks: &[(usize, usize)],
         code_spans: &[CodeSpan],
     ) -> Vec<ParsedImage> {
+        use crate::utils::skip_context::is_in_html_comment;
+
         // Pre-size based on a heuristic: images are less common than links
         let mut images = Vec::with_capacity(content.len() / 1000); // ~1 image per 1000 chars
 
@@ -905,6 +917,11 @@ impl<'a> LintContext<'a> {
                 continue;
             }
 
+            // Skip if in HTML comment
+            if is_in_html_comment(content, match_start) {
+                continue;
+            }
+
             // Find which line this image starts on
             let mut line_num = 1;
             let mut col_start = match_start;
@@ -939,7 +956,10 @@ impl<'a> LintContext<'a> {
 
             let alt_text = cap.get(1).map_or("", |m| m.as_str()).to_string();
 
-            if let Some(inline_url) = cap.get(2) {
+            // URL can be in group 2 (angle brackets) or group 3 (bare)
+            let inline_url = cap.get(2).or_else(|| cap.get(3));
+
+            if let Some(url_match) = inline_url {
                 // Inline image
                 images.push(ParsedImage {
                     line: line_num,
@@ -948,11 +968,11 @@ impl<'a> LintContext<'a> {
                     byte_offset: match_start,
                     byte_end: match_end,
                     alt_text,
-                    url: inline_url.as_str().to_string(),
+                    url: url_match.as_str().to_string(),
                     is_reference: false,
                     reference_id: None,
                 });
-            } else if let Some(ref_id) = cap.get(3) {
+            } else if let Some(ref_id) = cap.get(6) {
                 // Reference image
                 let ref_id_str = ref_id.as_str();
                 let normalized_ref = if ref_id_str.is_empty() {
@@ -1090,75 +1110,79 @@ impl<'a> LintContext<'a> {
                 byte_offset >= start && byte_offset < end && (is_multiline || is_fenced || is_indented)
             });
 
-            // Detect list items (skip if in frontmatter or in mkdocstrings block)
+            // Detect list items (skip if in frontmatter, in mkdocstrings block, or in HTML comment)
             let in_mkdocstrings = flavor == MarkdownFlavor::MkDocs
                 && crate::utils::mkdocstrings_refs::is_within_autodoc_block(content, byte_offset);
-            let list_item =
-                if !(in_code_block || is_blank || in_mkdocstrings || (front_matter_end > 0 && i < front_matter_end)) {
-                    // Strip blockquote prefix if present for list detection
-                    let (line_for_list_check, blockquote_prefix_len) =
-                        if let Some(caps) = BLOCKQUOTE_REGEX.captures(line) {
-                            let prefix = caps.get(1).unwrap().as_str();
-                            let content = caps.get(2).unwrap().as_str();
-                            (content, prefix.len())
-                        } else {
-                            (&**line, 0)
-                        };
+            let in_html_comment = crate::utils::skip_context::is_in_html_comment(content, byte_offset);
+            let list_item = if !(in_code_block
+                || is_blank
+                || in_mkdocstrings
+                || in_html_comment
+                || (front_matter_end > 0 && i < front_matter_end))
+            {
+                // Strip blockquote prefix if present for list detection
+                let (line_for_list_check, blockquote_prefix_len) = if let Some(caps) = BLOCKQUOTE_REGEX.captures(line) {
+                    let prefix = caps.get(1).unwrap().as_str();
+                    let content = caps.get(2).unwrap().as_str();
+                    (content, prefix.len())
+                } else {
+                    (&**line, 0)
+                };
 
-                    if let Some(caps) = UNORDERED_REGEX.captures(line_for_list_check) {
-                        let leading_spaces = caps.get(1).map_or("", |m| m.as_str());
-                        let marker = caps.get(2).map_or("", |m| m.as_str());
-                        let spacing = caps.get(3).map_or("", |m| m.as_str());
-                        let _content = caps.get(4).map_or("", |m| m.as_str());
-                        let marker_column = blockquote_prefix_len + leading_spaces.len();
-                        let content_column = marker_column + marker.len() + spacing.len();
-
-                        // According to CommonMark spec, unordered list items MUST have at least one space
-                        // after the marker (-, *, or +). Without a space, it's not a list item.
-                        // This also naturally handles cases like:
-                        // - *emphasis* (not a list)
-                        // - **bold** (not a list)
-                        // - --- (horizontal rule, not a list)
-                        if spacing.is_empty() {
-                            None
-                        } else {
-                            Some(ListItemInfo {
-                                marker: marker.to_string(),
-                                is_ordered: false,
-                                number: None,
-                                marker_column,
-                                content_column,
-                            })
-                        }
-                    } else if let Some(caps) = ORDERED_REGEX.captures(line_for_list_check) {
-                        let leading_spaces = caps.get(1).map_or("", |m| m.as_str());
-                        let number_str = caps.get(2).map_or("", |m| m.as_str());
-                        let delimiter = caps.get(3).map_or("", |m| m.as_str());
-                        let spacing = caps.get(4).map_or("", |m| m.as_str());
-                        let _content = caps.get(5).map_or("", |m| m.as_str());
-                        let marker = format!("{number_str}{delimiter}");
-                        let marker_column = blockquote_prefix_len + leading_spaces.len();
-                        let content_column = marker_column + marker.len() + spacing.len();
-
-                        // According to CommonMark spec, ordered list items MUST have at least one space
-                        // after the marker (period or parenthesis). Without a space, it's not a list item.
-                        if spacing.is_empty() {
-                            None
-                        } else {
-                            Some(ListItemInfo {
-                                marker,
-                                is_ordered: true,
-                                number: number_str.parse().ok(),
-                                marker_column,
-                                content_column,
-                            })
-                        }
+                if let Some(caps) = UNORDERED_REGEX.captures(line_for_list_check) {
+                    let leading_spaces = caps.get(1).map_or("", |m| m.as_str());
+                    let marker = caps.get(2).map_or("", |m| m.as_str());
+                    let spacing = caps.get(3).map_or("", |m| m.as_str());
+                    let _content = caps.get(4).map_or("", |m| m.as_str());
+                    let marker_column = blockquote_prefix_len + leading_spaces.len();
+                    let content_column = marker_column + marker.len() + spacing.len();
+
+                    // According to CommonMark spec, unordered list items MUST have at least one space
+                    // after the marker (-, *, or +). Without a space, it's not a list item.
+                    // This also naturally handles cases like:
+                    // - *emphasis* (not a list)
+                    // - **bold** (not a list)
+                    // - --- (horizontal rule, not a list)
+                    if spacing.is_empty() {
+                        None
                     } else {
+                        Some(ListItemInfo {
+                            marker: marker.to_string(),
+                            is_ordered: false,
+                            number: None,
+                            marker_column,
+                            content_column,
+                        })
+                    }
+                } else if let Some(caps) = ORDERED_REGEX.captures(line_for_list_check) {
+                    let leading_spaces = caps.get(1).map_or("", |m| m.as_str());
+                    let number_str = caps.get(2).map_or("", |m| m.as_str());
+                    let delimiter = caps.get(3).map_or("", |m| m.as_str());
+                    let spacing = caps.get(4).map_or("", |m| m.as_str());
+                    let _content = caps.get(5).map_or("", |m| m.as_str());
+                    let marker = format!("{number_str}{delimiter}");
+                    let marker_column = blockquote_prefix_len + leading_spaces.len();
+                    let content_column = marker_column + marker.len() + spacing.len();
+
+                    // According to CommonMark spec, ordered list items MUST have at least one space
+                    // after the marker (period or parenthesis). Without a space, it's not a list item.
+                    if spacing.is_empty() {
                         None
+                    } else {
+                        Some(ListItemInfo {
+                            marker,
+                            is_ordered: true,
+                            number: number_str.parse().ok(),
+                            marker_column,
+                            content_column,
+                        })
                     }
                 } else {
                     None
-                };
+                }
+            } else {
+                None
+            };
 
             lines.push(LineInfo {
                 content: line.to_string(),
@@ -1168,6 +1192,7 @@ impl<'a> LintContext<'a> {
                 in_code_block,
                 in_front_matter: front_matter_end > 0 && i < front_matter_end,
                 in_html_block: false, // Will be populated after line creation
+                in_html_comment,
                 list_item,
                 heading: None,    // Will be populated in second pass for Setext headings
                 blockquote: None, // Will be populated after line creation