rumdl 0.0.166__tar.gz → 0.0.168__tar.gz

{rumdl-0.0.166 → rumdl-0.0.168}/.config/nextest.toml

@@ -22,21 +22,24 @@ status-level = "pass"
 
 [profile.ci]
 
-# Skip performance tests in CI (they're flaky due to resource variability)
+# Skip performance and memory tests in CI (they're flaky due to resource variability)
 # Exclude specific integration test binaries and performance-related test functions
-default-filter = 'not (package(rumdl) and binary(deeply_nested_lists_performance_test)) and not (package(rumdl) and binary(performance_validation_tests)) and not (package(rumdl) and binary(perf_check)) and not test(/performance|benchmark/)'
+default-filter = 'not (package(rumdl) and binary(deeply_nested_lists_performance_test)) and not (package(rumdl) and binary(performance_validation_tests)) and not (package(rumdl) and binary(perf_check)) and not test(/performance|benchmark|memory/)'
 
 # More conservative in CI
 test-threads = "num-cpus"
 
-# Always show all output in CI
+# Show failures immediately, but minimize successful test output for speed
 failure-output = "immediate"
-success-output = "immediate"
-status-level = "all"
+success-output = "final"
+status-level = "pass"
 
 # No retries in CI to catch flaky tests
 retries = 0
 
+# Fail fast on first failure to save CI time
+fail-fast = true
+
 # Quick profile for development
 [profile.quick]
 
@@ -88,8 +91,8 @@ fail-fast = true
 # Performance testing profile - for scheduled/manual runs
 [profile.performance]
 
-# Only run performance and benchmark tests
-default-filter = 'test(performance) or test(benchmark) or test(deeply_nested)'
+# Only run performance, benchmark, and memory tests
+default-filter = 'test(performance) or test(benchmark) or test(deeply_nested) or test(memory)'
 
 # Run tests serially to reduce noise
 test-threads = 1

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

@@ -8,6 +8,8 @@
 #   pre-commit run --hook-stage push --all-files       # Run push hooks
 #   pre-commit run --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
 
+fail_fast: true
+
 repos:
   # Conventional Commits validation
   - repo: https://github.com/compilerla/conventional-pre-commit
@@ -42,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
@@ -58,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)
@@ -99,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.166 → rumdl-0.0.168}/.rumdl.toml

@@ -8,11 +8,11 @@ include = [
 ]
 # Globally disable specific rules
 disable = ["MD033"]
-respect_gitignore = true
+respect-gitignore = true
 
 [MD013]
-line_length = 200
-code_blocks = true
+line-length = 200
+code-blocks = true
 tables = false
 headings = true
 reflow = true

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

@@ -7,6 +7,204 @@ 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
+
+- **Configuration validation with fuzzy-match suggestions**
+  - Comprehensive unknown key detection for `.rumdl.toml` and `pyproject.toml`
+  - Intelligent "did you mean?" suggestions using Levenshtein distance algorithm
+  - File path context in validation warnings for easy debugging
+  - Catches typos in global options, rule names, and rule options
+  - Example: `line-lenght` → suggests `line-length`, `reflw` → suggests `reflow`
+  - Zero-dependency implementation with configurable similarity threshold
+  - Helps users catch configuration mistakes before they cause confusion
+
+- **MD053: Support for community comment-style references**
+  - Recognizes and ignores reference-style link syntax used as comments
+  - Supports widely-used patterns: `[//]: # (comment)`, `[comment]: #`, `[note]: #`, `[todo]: #`, `[fixme]: #`, `[hack]: #`
+  - Any reference with just `#` as URL is treated as a comment
+  - While not in CommonMark/GFM specs, used across 23+ markdown implementations
+  - Complements HTML comments with a less HTML-like syntax option
+  - Improves compatibility with existing markdown practices
+
+- **MD013: `line-length = 0` to disable all line length checks**
+  - Setting `line-length = 0` now completely disables MD013 rule
+  - Provides explicit way to turn off line length validation entirely
+  - More intuitive than previous workarounds
+  - Useful when line length management is handled by other tools or not desired
+
+- **MD051: mdbook template support**
+  - Added detection and slug generation for mdbook templates
+  - Recognizes `{{#template path/to/file.md}}` syntax
+  - Properly generates GitHub-compatible slugs for template-included headings
+  - Improves compatibility with mdbook documentation projects
+
+- **LSP: Manual "Reflow paragraph" code action for MD013 warnings**
+  - New code action available for MD013 line length warnings when auto-reflow is disabled
+  - Allows users to manually reflow specific paragraphs without enabling global reflow in config
+  - Appears as "Reflow paragraph" in Quick Fix menu (not marked as preferred, so won't trigger on save)
+  - Intelligently detects paragraph boundaries and reflows entire paragraph, not just the flagged line
+  - Respects line length limit from warning message or defaults to 80 characters
+  - Provides a way to try paragraph reflow before committing to enabling it globally
+  - Gives users fine-grained control over which paragraphs to reflow
+
+### Fixed
+
+- **LSP: Preserve trailing newline in reflow action**
+  - Manual reflow code action now correctly preserves trailing newlines
+  - Prevents unwanted file modifications from reflow operations
+  - Maintains document structure integrity
+
+- **LSP: Improve logging and resolve auto-fix issues**
+  - Enhanced LSP server logging for better debugging
+  - Resolved various auto-fix edge cases and reliability issues
+
+- **MD051: Correct GitHub slug generation for angle brackets**
+  - Fixed incorrect slug generation for headings containing angle brackets
+  - Now properly handles special characters in anchor generation
+  - Improves accuracy of link validation for complex headings
+
+### Changed
+
+- **MD033: Remove unhelpful message suffix**
+  - Simplified warning messages for inline HTML detection
+  - Removed redundant information to reduce noise
+  - Cleaner, more focused error messages
+
+- **Code cleanup: Remove dead code**
+  - Removed unused `LinkImageStyle` enum from MD054
+  - General refactoring to improve maintainability
+  - Fixed clippy warnings
+
+### Documentation
+
+- **MD033: Document mdbook use case for semantic HTML**
+  - Added documentation about using semantic HTML in mdbook projects
+  - Clarifies when and why inline HTML might be intentionally used
+  - Helps users understand legitimate use cases for HTML in markdown
+
 ## [0.0.166] - 2025-10-22
 
 ### Added

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

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

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

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.166"
+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.166 → rumdl-0.0.168}/Makefile

@@ -95,8 +95,8 @@ test-pre-commit:
 	cargo nextest run --profile pre-commit
 
 test-push:
-	@echo "Running comprehensive test suite (~30s, excludes slow/performance tests)..."
-	cargo nextest run --profile dev
+	@echo "Running CI test suite (excludes performance tests)..."
+	cargo nextest run --profile ci
 
 test-ci:
 	cargo nextest run --profile ci

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

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

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

@@ -62,7 +62,7 @@ MD013:
 
 ### Configuration options explained
 
-- `line_length`: The maximum number of characters allowed per line
+- `line_length`: The maximum number of characters allowed per line (set to `0` to disable all line length checks)
 - `code_blocks`: Whether to check line length in code blocks
 - `tables`: Whether to check line length in tables
 - `headings`: Whether to check line length in headings
@@ -195,6 +195,29 @@ This configuration is useful when:
 - You care about line length in code blocks and tables but not in regular text
 - You're using semantic line breaks where sentence length is determined by content, not arbitrary limits
 
+#### Disabling all line length checks
+
+If you want to completely disable all line length checking (for paragraphs, headings, code blocks, and tables), set `line-length` to `0`:
+
+```yaml
+MD013:
+  line-length: 0  # Disable all line length checks
+  reflow: true
+  reflow-mode: "sentence-per-line"
+```
+
+When `line-length` is set to `0`, no line length warnings will be reported for any content type. This is particularly useful for:
+
+- Projects using semantic line breaks where lines break at logical boundaries regardless of length
+- 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` 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
 
 ```yaml

{rumdl-0.0.166 → rumdl-0.0.168}/docs/md033.md

@@ -89,6 +89,24 @@ MD033:
 
 This would allow line breaks, horizontal rules, and collapsible sections while blocking other HTML.
 
+### mdbook projects with semantic HTML
+
+mdbook documentation often uses HTML with CSS classes to add semantic meaning that pure Markdown cannot express (e.g., marking text as filenames, captions, or warnings). For mdbook projects, you can
+allow semantic containers:
+
+```toml
+[tool.rumdl.MD033]
+allowed-elements = ["div", "span"]
+```
+
+This permits semantic HTML like:
+
+- `<span class="filename">src/main.rs</span>` - Filename styling
+- `<div class="warning">Important note</div>` - Warning boxes
+- `<span class="caption">Figure 1: Architecture</span>` - Figure captions
+
+While still catching potentially problematic HTML like `<em>`, `<strong>`, or `<script>` tags that have Markdown equivalents or security concerns.
+
 ## Automatic fixes
 
 This rule can automatically remove HTML tags when no allowed elements are configured. When specific tags are allowed via `allowed_elements`, those tags will be preserved while others are removed.

{rumdl-0.0.166 → rumdl-0.0.168}/docs/md053.md

@@ -64,6 +64,65 @@ MD053:
 
 This keeps reference definitions with names like "todo", "draft", or "template" even if they're not currently used.
 
+## Comment-Style References
+
+rumdl automatically recognizes and ignores common community patterns for adding comments using reference-style syntax. These patterns are **not part of any official Markdown specification**
+(CommonMark, GFM), but are widely used across 23+ Markdown implementations.
+
+### Recognized Comment Patterns
+
+The following patterns are automatically ignored and won't be flagged as unused:
+
+```markdown
+[//]: # (This is a comment - most popular pattern)
+[comment]: # (This is a semantic comment)
+[note]: # (This is a note for documentation)
+[todo]: # (Add more examples here)
+[fixme]: # (This needs to be fixed)
+[hack]: # (Temporary workaround)
+```
+
+Any reference definition with just `#` as the URL is also treated as a comment:
+
+```markdown
+[anything]: # (This will be treated as a comment)
+[ref]: # "Also a comment"
+```
+
+### Why These Work
+
+These patterns exploit valid Markdown link reference syntax:
+
+- The label (e.g., `[//]`) is technically valid
+- The `#` is a valid URL (just a fragment/anchor)
+- Since the reference is never used, it doesn't render
+
+### When to Use
+
+**Use HTML comments for standard commenting:**
+
+```markdown
+<!-- This is the recommended way to add comments -->
+```
+
+**Use reference-style comments when:**
+
+- Your documentation tool strips HTML comments
+- You prefer a less HTML-like syntax
+- You're following project conventions that use this pattern
+- You need comments that won't appear in page source
+
+### Real vs. Comment References
+
+rumdl distinguishes between comment patterns and real references:
+
+```markdown
+[//]: # (This is ignored - it's a comment)
+[real-link]: https://example.com  <!-- This WILL be flagged if unused -->
+```
+
+Only the real reference definition will trigger MD053 if it's not used in the document.
+
 ## Automatic fixes
 
 This rule can automatically fix issues by: