rumdl 0.0.167__tar.gz → 0.0.168__tar.gz

{rumdl-0.0.167 → rumdl-0.0.168}/.pre-commit-config.yaml

@@ -44,6 +44,14 @@ repos:
         pass_filenames: false
         stages: [pre-commit]
 
+      - id: cargo-lock-check
+        name: check Cargo.lock is up-to-date
+        entry: cargo check --locked
+        language: system
+        files: ^(Cargo\.(toml|lock)|.*\.rs)$
+        pass_filenames: false
+        stages: [pre-commit]
+
   # General file quality checks
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
@@ -60,12 +68,12 @@ repos:
       - id: mixed-line-ending
         args: [--fix=lf]
 
-  # Markdown linting using rumdl itself (local binary)
+  # Markdown linting using rumdl itself (cargo run)
   - repo: local
     hooks:
       - id: rumdl
         name: rumdl check
-        entry: ./target/release/rumdl check
+        entry: cargo run --quiet -- check
         language: system
         files: \.md$
         exclude: ^(test_tmp|benchmark/test-data|docs/temp|CHANGELOG\.md)
@@ -101,3 +109,12 @@ repos:
         pass_filenames: false
         stages: [pre-push]
         verbose: true
+
+      - id: cargo-lock-check-push
+        name: verify Cargo.lock is committed and up-to-date
+        entry: cargo check --locked
+        language: system
+        files: ^(Cargo\.(toml|lock)|.*\.rs)$
+        pass_filenames: false
+        stages: [pre-push]
+        verbose: true

{rumdl-0.0.167 → rumdl-0.0.168}/CHANGELOG.md

@@ -7,6 +7,127 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.168] - 2025-10-28
+
+### Added
+
+- **CLI: Support for Quarto (.qmd) and RMarkdown (.rmd/.Rmd) files**
+  - Added support for `.qmd` (Quarto), `.rmd` and `.Rmd` (RMarkdown) file extensions
+  - Enables markdown linting for data science and scientific documentation workflows
+  - Particularly useful for Jupyter-based publishing and reproducible research documents
+
+- **LSP: will_save_wait_until for proper auto-fix on save**
+  - Implemented LSP `textDocument/willSaveWaitUntil` capability
+  - Provides proper auto-fix on save support in compatible editors
+  - More reliable than `textDocument/didSave` approach
+  - Ensures fixes are applied before file is actually saved to disk
+
+- **MD033: LSP Quick Fix to remove HTML tags while keeping content**
+  - New code action removes HTML opening and closing tags while preserving inner content
+  - Helps convert inline HTML to plain text when needed
+  - Available through editor Quick Fix menu (Ctrl+. or Cmd+.)
+
+### Fixed
+
+- **MD013: Skip auto-fix for list items containing HTML tags**
+  - Prevents broken auto-fix when HTML tags are present in list items
+  - HTML structure (indentation, tag hierarchy) is now preserved
+  - Errors are still reported but no destructive fix is applied
+  - Pragmatic solution until full HTML-aware reflow is implemented
+  - Fixes issues where tags like `</details>` were split or indentation was lost
+
+- **MD013: Fix incorrect sentence splitting after abbreviations in sentence-per-line mode**
+  - No longer incorrectly splits sentences after common abbreviations (e.g., etc., i.e., Dr., Mr.)
+  - Improved sentence detection algorithm for better accuracy
+  - Prevents unwanted line breaks in the middle of sentences
+
+- **MD013: Prevent autolinks from being parsed as HTML tags**
+  - Autolinks like `<https://example.com>` are no longer treated as HTML
+  - Fixes false positives in HTML detection that could skip auto-fix unnecessarily
+  - Properly distinguishes between markdown autolinks and actual HTML tags
+
+- **MD013: Prevent content duplication in sentence-per-line reflow**
+  - Fixed bug where content could be duplicated during paragraph reflow
+  - Ensures each sentence appears exactly once in reflowed output
+  - Improves reliability of auto-fix in sentence-per-line mode
+
+- **MD013: Improve sentence-per-line error messages and highlighting**
+  - Better error messages that clearly indicate sentence-per-line violations
+  - More accurate highlighting of problematic text
+  - Helps users understand what needs to be fixed
+
+- **MD013: Skip template directives at paragraph start in sentence-per-line mode**
+  - Template directives (like `{{ variable }}`) at start of paragraphs no longer cause issues
+  - Prevents false positives in templated markdown files
+  - Improves compatibility with static site generators and template engines
+
+- **MD013: Treat template directives as paragraph boundaries**
+  - Template directives now properly separate paragraphs during reflow
+  - Prevents template syntax from being joined with regular content
+  - Better handling of mixed template and markdown content
+
+- **MD013: Join single-sentence paragraphs in sentence-per-line mode**
+  - Single-sentence paragraphs that span multiple lines are now properly joined
+  - Fixes issues where short paragraphs were incorrectly flagged
+  - Improves consistency of sentence-per-line formatting
+
+- **MD013: Handle multiple spaces and multi-line paragraphs in sentence-per-line mode**
+  - Better handling of paragraphs with inconsistent spacing
+  - Multi-line paragraphs are now correctly reflowed
+  - Fixes edge cases in whitespace handling
+
+- **MD052: Preserve backtick-wrapped patterns with dots in MkDocs mode**
+  - Backtick-wrapped references like `` `[foo.bar]` `` now preserve dots in slugs
+  - Matches MkDocs behavior of treating code-wrapped text literally
+  - Prevents false positives for code examples in documentation
+
+- **MD052: Support Pandoc citations and inline footnotes in RMarkdown/Quarto**
+  - Recognizes Pandoc citation syntax: `[@citation]`, `@citation`, `[-@citation]`
+  - Recognizes inline footnote syntax: `^[footnote text]`
+  - No longer treats these as reference-style links
+  - Essential for academic and scientific writing in RMarkdown and Quarto
+
+- **MD033: Only report opening HTML tags, not closing tags**
+  - MD033 violations now only report the opening tag of an HTML element
+  - Reduces noise in linting output (one violation per element vs two)
+  - Closing tags like `</div>` are no longer separately reported
+  - Makes HTML-related warnings clearer and less redundant
+
+- **MD018: Skip CSS selectors and JS code inside HTML blocks**
+  - CSS selectors like `#slide-1` inside `<style>` tags no longer trigger MD018
+  - JavaScript code inside `<script>` tags is properly ignored
+  - Prevents false positives for Quarto and RMarkdown files with embedded HTML/CSS/JS
+  - Particularly important for interactive documents and custom styling
+
+- **MD012: Enforce exactly 1 newline at EOF and clean LSP logging**
+  - Files now must end with exactly one newline character (not zero, not two)
+  - Aligns with POSIX standard and common editor behavior
+  - Improved LSP logging with less noise
+
+- **CI: Use cargo run instead of release binary in rumdl pre-commit hook**
+  - Pre-commit hooks now use `cargo run` for more reliable execution
+  - Prevents issues with stale release binaries during development
+  - Better integration with cargo workflow
+
+- **Schema: Allow root-level rule sections like [MD013] in config validation**
+  - Configuration schema now correctly allows `[MD013]` style sections
+  - Fixes false validation errors for valid TOML config
+  - Better compatibility with common configuration patterns
+
+### Changed
+
+- **Refactor: Detect HTML blocks before parsing headings**
+  - Reordered LintContext initialization to detect HTML blocks first
+  - Headings are no longer detected inside HTML blocks (like `<style>` or `<script>`)
+  - Architectural improvement that prevents multiple false positives
+  - Benefits MD018 and other heading-related rules
+  - More correct parsing aligned with markdown specifications
+
+- **Refactor: Use filtered_lines() for front-matter handling in MD011 and MD012**
+  - Improved front-matter handling using consistent filtered_lines API
+  - Better code reuse and maintainability
+  - More reliable front-matter detection across rules
+
 ## [0.0.167] - 2025-10-24
 
 ### Added

{rumdl-0.0.167 → rumdl-0.0.168}/Cargo.lock

@@ -1983,7 +1983,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.167"
+version = "0.0.168"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.167 → rumdl-0.0.168}/Cargo.toml

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

{rumdl-0.0.167 → rumdl-0.0.168}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.167
+Version: 0.0.168
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers

{rumdl-0.0.167 → rumdl-0.0.168}/docs/md013.md

@@ -212,7 +212,11 @@ When `line-length` is set to `0`, no line length warnings will be reported for a
 - Sentence-per-line workflows where line length is not a concern
 - Documentation where long lines (e.g., URLs, technical terms) are unavoidable and acceptable
 
-**Note**: With `line-length: 0`, reflow still works (using a very large effective line length), so you can still use `sentence-per-line` mode for automatic formatting without any line length warnings.
+**Note**: With `line-length: 0` and `reflow-mode: "sentence-per-line"`, rumdl will:
+
+- Split multiple sentences that share a line into separate lines
+- Join single sentences that span multiple lines into one line (since there's no length constraint)
+- Provide consistent "one sentence = one line" formatting throughout your document
 
 ### Example with automatic reflow
 

{rumdl-0.0.167 → rumdl-0.0.168}/rumdl.schema.json

@@ -1,107 +1,73 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Config",
-  "description": "rumdl configuration for linting Markdown files. Rules can be configured individually using [MD###] sections with rule-specific options.",
-  "type": "object",
-  "properties": {
-    "global": {
-      "description": "Global configuration options",
-      "default": {
-        "disable": [],
-        "enable": [],
-        "exclude": [],
-        "fixable": [],
-        "flavor": "standard",
-        "force_exclude": false,
-        "include": [],
-        "line_length": 80,
-        "respect_gitignore": true,
-        "unfixable": []
-      },
-      "allOf": [
-        {
-          "$ref": "#/definitions/GlobalConfig"
-        }
-      ]
-    },
-    "per-file-ignores": {
-      "description": "Per-file rule ignores: maps file patterns to lists of rules to ignore Example: { \"README.md\": [\"MD033\"], \"docs/**/*.md\": [\"MD013\"] }",
-      "default": {},
-      "type": "object",
-      "additionalProperties": {
-        "type": "array",
-        "items": {
-          "type": "string"
-        }
-      }
-    }
+  "additionalProperties": {
+    "$ref": "#/definitions/RuleConfig"
   },
   "definitions": {
     "GlobalConfig": {
       "description": "Global configuration options",
-      "type": "object",
       "properties": {
         "disable": {
-          "description": "Disabled rules",
           "default": [],
-          "type": "array",
+          "description": "Disabled rules",
           "items": {
             "type": "string"
-          }
+          },
+          "type": "array"
         },
         "enable": {
-          "description": "Enabled rules",
           "default": [],
-          "type": "array",
+          "description": "Enabled rules",
           "items": {
             "type": "string"
-          }
+          },
+          "type": "array"
         },
         "exclude": {
-          "description": "Files to exclude",
           "default": [],
-          "type": "array",
+          "description": "Files to exclude",
           "items": {
             "type": "string"
-          }
+          },
+          "type": "array"
         },
         "fixable": {
-          "description": "Rules that are allowed to be fixed when --fix is used If specified, only these rules will be fixed",
           "default": [],
-          "type": "array",
+          "description": "Rules that are allowed to be fixed when --fix is used If specified, only these rules will be fixed",
           "items": {
             "type": "string"
-          }
+          },
+          "type": "array"
         },
         "flavor": {
-          "description": "Markdown flavor/dialect to use (mkdocs, gfm, commonmark, etc.) When set, adjusts parsing and validation rules for that specific Markdown variant",
-          "default": "standard",
           "allOf": [
             {
               "$ref": "#/definitions/MarkdownFlavor"
             }
-          ]
+          ],
+          "default": "standard",
+          "description": "Markdown flavor/dialect to use (mkdocs, gfm, commonmark, etc.) When set, adjusts parsing and validation rules for that specific Markdown variant"
         },
         "force_exclude": {
-          "description": "[DEPRECATED] Whether to enforce exclude patterns for explicitly passed paths. This option is deprecated as of v0.0.156 and has no effect. Exclude patterns are now always respected, even for explicitly provided files. This prevents duplication between rumdl config and tool configs like pre-commit.",
           "default": false,
           "deprecated": true,
+          "description": "[DEPRECATED] Whether to enforce exclude patterns for explicitly passed paths. This option is deprecated as of v0.0.156 and has no effect. Exclude patterns are now always respected, even for explicitly provided files. This prevents duplication between rumdl config and tool configs like pre-commit.",
           "type": "boolean"
         },
         "include": {
-          "description": "Files to include",
           "default": [],
-          "type": "array",
+          "description": "Files to include",
           "items": {
             "type": "string"
-          }
+          },
+          "type": "array"
         },
         "line_length": {
-          "description": "Global line length setting (used by MD013 and other rules if not overridden)",
           "default": 80,
-          "type": "integer",
+          "description": "Global line length setting (used by MD013 and other rules if not overridden)",
           "format": "uint64",
-          "minimum": 0.0
+          "minimum": 0.0,
+          "type": "integer"
         },
         "output_format": {
           "description": "Output format for linting results (e.g., \"text\", \"json\", \"pylint\", etc.)",
@@ -111,43 +77,80 @@
           ]
         },
         "respect_gitignore": {
-          "description": "Respect .gitignore files when scanning directories",
           "default": true,
+          "description": "Respect .gitignore files when scanning directories",
           "type": "boolean"
         },
         "unfixable": {
-          "description": "Rules that should never be fixed, even when --fix is used Takes precedence over fixable",
           "default": [],
-          "type": "array",
+          "description": "Rules that should never be fixed, even when --fix is used Takes precedence over fixable",
           "items": {
             "type": "string"
-          }
+          },
+          "type": "array"
         }
-      }
+      },
+      "type": "object"
     },
     "MarkdownFlavor": {
       "description": "Markdown flavor/dialect enumeration",
       "oneOf": [
         {
           "description": "Standard Markdown without flavor-specific adjustments",
-          "type": "string",
           "enum": [
             "standard"
-          ]
+          ],
+          "type": "string"
         },
         {
           "description": "MkDocs flavor with auto-reference support",
-          "type": "string",
           "enum": [
             "mkdocs"
-          ]
+          ],
+          "type": "string"
         }
       ]
     },
     "RuleConfig": {
+      "additionalProperties": true,
       "description": "Represents a rule-specific configuration",
-      "type": "object",
-      "additionalProperties": true
+      "type": "object"
+    }
+  },
+  "description": "rumdl configuration for linting Markdown files. Rules can be configured individually using [MD###] sections with rule-specific options.",
+  "properties": {
+    "global": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/GlobalConfig"
+        }
+      ],
+      "default": {
+        "disable": [],
+        "enable": [],
+        "exclude": [],
+        "fixable": [],
+        "flavor": "standard",
+        "force_exclude": false,
+        "include": [],
+        "line_length": 80,
+        "respect_gitignore": true,
+        "unfixable": []
+      },
+      "description": "Global configuration options"
+    },
+    "per-file-ignores": {
+      "additionalProperties": {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "default": {},
+      "description": "Per-file rule ignores: maps file patterns to lists of rules to ignore Example: { \"README.md\": [\"MD033\"], \"docs/**/*.md\": [\"MD013\"] }",
+      "type": "object"
     }
-  }
+  },
+  "title": "Config",
+  "type": "object"
 }

rumdl-0.0.168/scripts/verify-release-ready.sh

@@ -0,0 +1,99 @@
+#!/usr/bin/env bash
+# Script to verify that a release is ready to be tagged and pushed
+# This checks all the conditions that would cause a release to fail in CI
+
+set -euo pipefail
+
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+echo "🔍 Verifying release readiness..."
+echo ""
+
+ERRORS=0
+
+# Check 1: Verify Cargo.lock is up-to-date
+echo -n "Checking Cargo.lock is up-to-date... "
+if cargo check --locked &>/dev/null; then
+    echo -e "${GREEN}✓${NC}"
+else
+    echo -e "${RED}✗${NC}"
+    echo -e "${RED}ERROR: Cargo.lock is out of date or missing${NC}"
+    echo "Run: cargo check"
+    echo "Then commit the updated Cargo.lock"
+    ((ERRORS++))
+fi
+
+# Check 2: Verify no uncommitted changes
+echo -n "Checking for uncommitted changes... "
+if [[ -z $(git status --porcelain) ]]; then
+    echo -e "${GREEN}✓${NC}"
+else
+    echo -e "${RED}✗${NC}"
+    echo -e "${RED}ERROR: There are uncommitted changes${NC}"
+    git status --short
+    ((ERRORS++))
+fi
+
+# Check 3: Verify version consistency
+echo -n "Checking version consistency... "
+CARGO_VERSION=$(grep '^version =' Cargo.toml | head -1 | sed 's/.*"\(.*\)".*/\1/')
+LOCK_VERSION=$(grep -A 1 '^name = "rumdl"' Cargo.lock | grep '^version' | head -1 | sed 's/.*"\(.*\)".*/\1/')
+
+if [[ "$CARGO_VERSION" == "$LOCK_VERSION" ]]; then
+    echo -e "${GREEN}✓${NC} (v$CARGO_VERSION)"
+else
+    echo -e "${RED}✗${NC}"
+    echo -e "${RED}ERROR: Version mismatch!${NC}"
+    echo "Cargo.toml: $CARGO_VERSION"
+    echo "Cargo.lock: $LOCK_VERSION"
+    ((ERRORS++))
+fi
+
+# Check 4: Verify CHANGELOG.md has entry for current version
+echo -n "Checking CHANGELOG.md for v$CARGO_VERSION... "
+if grep -q "## \[${CARGO_VERSION}\]" CHANGELOG.md; then
+    echo -e "${GREEN}✓${NC}"
+else
+    echo -e "${YELLOW}⚠${NC}"
+    echo -e "${YELLOW}WARNING: No CHANGELOG entry found for v${CARGO_VERSION}${NC}"
+    echo "Consider adding a CHANGELOG entry before releasing"
+fi
+
+# Check 5: Verify we're on main branch
+echo -n "Checking current branch... "
+CURRENT_BRANCH=$(git branch --show-current)
+if [[ "$CURRENT_BRANCH" == "main" ]]; then
+    echo -e "${GREEN}✓${NC} (main)"
+else
+    echo -e "${YELLOW}⚠${NC}"
+    echo -e "${YELLOW}WARNING: Not on main branch (currently on: $CURRENT_BRANCH)${NC}"
+fi
+
+# Check 6: Verify tag doesn't already exist
+echo -n "Checking if tag v$CARGO_VERSION exists... "
+if git rev-parse "v$CARGO_VERSION" &>/dev/null; then
+    echo -e "${RED}✗${NC}"
+    echo -e "${RED}ERROR: Tag v$CARGO_VERSION already exists${NC}"
+    echo "Delete with: git tag -d v$CARGO_VERSION && git push origin --delete v$CARGO_VERSION"
+    ((ERRORS++))
+else
+    echo -e "${GREEN}✓${NC}"
+fi
+
+# Summary
+echo ""
+echo "════════════════════════════════════════"
+if [[ $ERRORS -eq 0 ]]; then
+    echo -e "${GREEN}✅ Release is ready!${NC}"
+    echo ""
+    echo "To create and push the release:"
+    echo "  git tag v$CARGO_VERSION"
+    echo "  git push origin main v$CARGO_VERSION"
+else
+    echo -e "${RED}❌ Release is NOT ready ($ERRORS errors)${NC}"
+    echo "Fix the errors above before tagging"
+    exit 1
+fi

{rumdl-0.0.167 → rumdl-0.0.168}/src/file_processor.rs

@@ -193,6 +193,14 @@ pub fn find_markdown_files(
     types_builder.add_defaults(); // Add standard types
     types_builder.add("markdown", "*.md").unwrap();
     types_builder.add("markdown", "*.markdown").unwrap();
+    types_builder.add("markdown", "*.mdx").unwrap();
+    types_builder.add("markdown", "*.mkd").unwrap();
+    types_builder.add("markdown", "*.mkdn").unwrap();
+    types_builder.add("markdown", "*.mdown").unwrap();
+    types_builder.add("markdown", "*.mdwn").unwrap();
+    types_builder.add("markdown", "*.qmd").unwrap();
+    types_builder.add("markdown", "*.rmd").unwrap();
+    types_builder.add("markdown", "*.Rmd").unwrap();
     types_builder.select("markdown"); // Select ONLY markdown for processing
     let types = types_builder.build().unwrap();
     walk_builder.types(types);
@@ -216,8 +224,19 @@ pub fn find_markdown_files(
         // 2. Config include is used ONLY in discovery mode if specified
         config.global.include.clone()
     } else if is_discovery_mode {
-        // 3. Default include (*.md, *.markdown) ONLY in discovery mode if no CLI/Config include
-        vec!["*.md".to_string(), "*.markdown".to_string()]
+        // 3. Default include (all markdown variants) ONLY in discovery mode if no CLI/Config include
+        vec![
+            "*.md".to_string(),
+            "*.markdown".to_string(),
+            "*.mdx".to_string(),
+            "*.mkd".to_string(),
+            "*.mkdn".to_string(),
+            "*.mdown".to_string(),
+            "*.mdwn".to_string(),
+            "*.qmd".to_string(),
+            "*.rmd".to_string(),
+            "*.Rmd".to_string(),
+        ]
     } else {
         // 4. Explicit path mode: No includes applied by default. Walk starts from explicit paths.
         Vec::new()
@@ -311,7 +330,10 @@ pub fn find_markdown_files(
             // If it's a file, check if it's a markdown file
             if path.is_file()
                 && let Some(ext) = path.extension()
-                && (ext == "md" || ext == "markdown")
+                && matches!(
+                    ext.to_str(),
+                    Some("md" | "markdown" | "mdx" | "mkd" | "mkdn" | "mdown" | "mdwn" | "qmd" | "rmd" | "Rmd")
+                )
             {
                 processed_explicit_files = true;
                 // Convert to relative path for pattern matching
@@ -414,11 +436,16 @@ pub fn find_markdown_files(
     file_paths.dedup();
 
     // --- Final Explicit Markdown Filter ---
-    // Ensure only files with .md or .markdown extensions are returned,
+    // Ensure only files with markdown extensions are returned,
     // regardless of how ignore crate overrides interacted with type filters.
     file_paths.retain(|path_str| {
         let path = Path::new(path_str);
-        path.extension().is_some_and(|ext| ext == "md" || ext == "markdown")
+        path.extension().is_some_and(|ext| {
+            matches!(
+                ext.to_str(),
+                Some("md" | "markdown" | "mdx" | "mkd" | "mkdn" | "mdown" | "mdwn" | "qmd" | "rmd" | "Rmd")
+            )
+        })
     });
     // -------------------------------------