rumdl 0.0.165__tar.gz → 0.0.167__tar.gz

{rumdl-0.0.165 → rumdl-0.0.167}/.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.165 → rumdl-0.0.167}/.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

{rumdl-0.0.165 → rumdl-0.0.167}/.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.165 → rumdl-0.0.167}/CHANGELOG.md

@@ -7,6 +7,102 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+- **MD013: `paragraphs` field to control paragraph line length checks** (resolves #121)
+  - New boolean config field `paragraphs` (defaults to `true`) allows disabling line length warnings for paragraph text
+  - Enables sentence-per-line formatting workflows without line length validation noise
+  - Still checks headings, tables, code blocks, blockquotes, and HTML when `paragraphs: false`
+  - Useful for semantic line breaks where sentence length is determined by content, not arbitrary limits
+  - Example configuration:
+    ```yaml
+    MD013:
+      paragraphs: false  # Don't warn about long paragraphs
+      code-blocks: true  # Still check code blocks
+      tables: true       # Still check tables
+      reflow: true
+      reflow-mode: "sentence-per-line"
+    ```
+
 ## [0.0.165] - 2025-10-21
 
 ### Fixed

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

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

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

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

{rumdl-0.0.165 → rumdl-0.0.167}/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.165 → rumdl-0.0.167}/PKG-INFO

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

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

@@ -51,6 +51,7 @@ MD013:
   code-blocks: false            # Don't check code blocks (default: true)
   tables: false                 # Don't check tables (default: true)
   headings: true                # Check headings (default: true)
+  paragraphs: true              # Check paragraph/regular text (default: true)
   heading-line-length: 120      # Different limit for headings (default: uses line_length)
   code-block-line-length: 150   # Different limit for code blocks (default: uses line_length)
   stern: false                  # Stricter checking without exceptions (default: false)
@@ -61,10 +62,11 @@ 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
+- `paragraphs`: Whether to check line length in regular text/paragraphs (when false, line_length is still used for reflow but no warnings are reported)
 - `heading_line_length`: Optional separate limit for headings (useful since headings often need to be longer)
 - `code_block_line_length`: Optional separate limit for code blocks
 - `stern`: When true, applies stricter checking without common exceptions
@@ -173,6 +175,45 @@ This mode is particularly useful for:
 - Documents maintained in version control where sentence-level diffs are clearer
 - Collaborative writing where different authors work on different sentences
 
+#### Sentence-per-line without line length warnings
+
+If you want to use sentence-per-line mode for formatting but don't want warnings about long sentences, you can disable paragraph checking while keeping code blocks and tables checked:
+
+```yaml
+MD013:
+  line-length: 80
+  paragraphs: false  # Don't warn about long paragraphs
+  code-blocks: true  # Still check code blocks
+  tables: true       # Still check tables
+  reflow: true
+  reflow-mode: "sentence-per-line"
+```
+
+This configuration is useful when:
+
+- You want automatic sentence-per-line formatting without validation noise
+- 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`, 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.
+
 ### Example with automatic reflow
 
 ```yaml

{rumdl-0.0.165 → rumdl-0.0.167}/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.165 → rumdl-0.0.167}/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: