rumdl 0.0.161__tar.gz → 0.0.163__tar.gz

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

@@ -7,6 +7,95 @@ 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
+
+- **Filtered Line Iterator Architecture**: New infrastructure for rule implementation
+  - Provides consistent interface for filtering out front matter, code blocks, and HTML blocks
+  - Eliminates manual context checking in individual rules
+  - Improves code maintainability and reduces duplication
+  - Enables easier implementation of new rules
+
+### Fixed
+
+- **MD052**: Skip code blocks in blockquotes when checking references
+  - Prevents false positives for reference syntax inside code blocks within blockquotes
+  - Properly handles nested markdown structures
+
+- **MD034**: Skip URLs in front matter
+  - URLs in YAML/TOML/JSON front matter no longer flagged as bare URLs
+  - Improves compatibility with static site generators
+
+- **Tests**: Fixed flaky `profiling::tests::test_concurrent_access` test
+  - Added `#[serial_test::serial]` attribute to prevent race conditions
+  - Ensures reliable test execution in CI/CD environments
+
+- **Documentation**: Build badge now displays correctly
+
+### Performance
+
+- **MD005**: Optimized continuation detection from O(n²) to O(n)
+  - Dramatically faster processing of documents with many list items
+  - Eliminates redundant line scanning
+
+- **General**: Consolidated multiple `line_info()` calls for same line
+  - Reduced redundant lookups across multiple rules
+  - Improved overall linting performance
+
+### Changed
+
+- **Internal Refactoring**: Eliminated manual checks across all rules
+  - Removed manual front matter detection from individual rules
+  - Removed manual code block detection from individual rules
+  - Removed manual HTML block detection from individual rules
+  - All rules now use centralized filtering infrastructure
+
+### Documentation
+
+- **Per-File-Ignores**: Added comprehensive documentation for per-file-ignores feature
+  - Detailed usage examples with glob patterns
+  - Integration with both `.rumdl.toml` and `pyproject.toml`
+
 ## [0.0.161] - 2025-10-15
 
 ### Added
@@ -1058,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.161 → rumdl-0.0.163}/Cargo.lock

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

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

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.161"
+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.161 → rumdl-0.0.163}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.161
+Version: 0.0.163
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -33,7 +33,7 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
 
 ![rumdl Logo](https://raw.githubusercontent.com/rvben/rumdl/main/assets/logo.png)
 
-[![Build Status](https://img.shields.io/github/actions/workflow/status/rvben/rumdl/build.yml?branch=main)](https://github.com/rvben/rumdl/actions)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/rvben/rumdl/release.yml?branch=main)](https://github.com/rvben/rumdl/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Crates.io](https://img.shields.io/crates/v/rumdl)](https://crates.io/crates/rumdl)
 [![PyPI](https://img.shields.io/pypi/v/rumdl)](https://pypi.org/project/rumdl/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/rvben/rumdl)](https://github.com/rvben/rumdl/releases/latest) [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl)](https://github.com/rvben/rumdl/stargazers)
 
@@ -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
@@ -726,6 +739,12 @@ respect-gitignore = true
 # Disable specific rules
 disabled-rules = ["MD013", "MD033"]
 
+# Disable specific rules for specific files
+[per-file-ignores]
+"README.md" = ["MD033"]  # Allow HTML in README
+"SUMMARY.md" = ["MD025"]  # Allow multiple H1 in table of contents
+"docs/api/**/*.md" = ["MD013", "MD041"]  # Relax rules for generated docs
+
 # Configure individual rules
 [MD007]
 indent = 2

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

@@ -4,7 +4,7 @@
 
 ![rumdl Logo](https://raw.githubusercontent.com/rvben/rumdl/main/assets/logo.png)
 
-[![Build Status](https://img.shields.io/github/actions/workflow/status/rvben/rumdl/build.yml?branch=main)](https://github.com/rvben/rumdl/actions)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/rvben/rumdl/release.yml?branch=main)](https://github.com/rvben/rumdl/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Crates.io](https://img.shields.io/crates/v/rumdl)](https://crates.io/crates/rumdl)
 [![PyPI](https://img.shields.io/pypi/v/rumdl)](https://pypi.org/project/rumdl/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/rvben/rumdl)](https://github.com/rvben/rumdl/releases/latest) [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl)](https://github.com/rvben/rumdl/stargazers)
 
@@ -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
@@ -697,6 +710,12 @@ respect-gitignore = true
 # Disable specific rules
 disabled-rules = ["MD013", "MD033"]
 
+# Disable specific rules for specific files
+[per-file-ignores]
+"README.md" = ["MD033"]  # Allow HTML in README
+"SUMMARY.md" = ["MD025"]  # Allow multiple H1 in table of contents
+"docs/api/**/*.md" = ["MD013", "MD041"]  # Relax rules for generated docs
+
 # Configure individual rules
 [MD007]
 indent = 2

{rumdl-0.0.161 → rumdl-0.0.163}/docs/global-settings.md

@@ -13,6 +13,7 @@ Global settings are configured in the `[global]` section of your configuration f
 |---------|------|---------|-------------|
 | [`enable`](#enable) | `string[]` | `[]` | Enable only specific rules |
 | [`disable`](#disable) | `string[]` | `[]` | Disable specific rules |
+| [`per-file-ignores`](#per-file-ignores) | `table` | `{}` | Disable specific rules for specific files |
 | [`exclude`](#exclude) | `string[]` | `[]` | Files/directories to exclude |
 | [`include`](#include) | `string[]` | `[]` | Files/directories to include |
 | [`respect_gitignore`](#respect_gitignore) | `boolean` | `true` | Respect .gitignore files |
@@ -55,6 +56,12 @@ line_length = 120
 
 # Set markdown flavor (standard, mkdocs)
 flavor = "mkdocs"
+
+# Disable specific rules for specific files
+[per-file-ignores]
+"README.md" = ["MD033"]  # Allow inline HTML in README
+"docs/api/**/*.md" = ["MD013", "MD041"]  # Generated API docs
+"SUMMARY.md" = ["MD025"]  # MkDocs/mdBook table of contents
 ```
 
 ### pyproject.toml Configuration
@@ -69,6 +76,11 @@ include = ["docs/*.md", "README.md"]
 respect_gitignore = true
 line_length = 120
 flavor = "standard"
+
+# Per-file rule ignores (both snake_case and kebab-case supported)
+[tool.rumdl.per-file-ignores]
+"README.md" = ["MD033"]
+"SUMMARY.md" = ["MD025"]
 ```
 
 ## Detailed Settings Reference
@@ -127,6 +139,96 @@ disable = ["MD013", "MD033", "MD041"]
 rumdl check --disable MD013,MD033 .
 ```
 
+### `per-file-ignores`
+
+**Type**: `table` (file patterns mapped to rule arrays)
+**Default**: `{}` (no per-file ignores)
+**CLI Equivalent**: None (configuration file only)
+
+Disables specific rules for specific files or file patterns. This is useful when certain files have different requirements than the rest of your documentation.
+
+```toml
+[per-file-ignores]
+# Disable inline HTML check for GitHub README (often has badges)
+"README.md" = ["MD033"]
+
+# Disable line length and first-line heading for generated API docs
+"docs/api/**/*.md" = ["MD013", "MD041"]
+
+# Allow multiple top-level headings in table of contents files
+"SUMMARY.md" = ["MD025"]
+"**/TOC.md" = ["MD025"]
+
+# Disable heading style check for legacy documentation
+"docs/legacy/**/*.md" = ["MD003", "MD022"]
+```
+
+**Usage Notes**:
+
+- Patterns support glob syntax (`*`, `**`, `?`)
+- Rule IDs are case-insensitive but conventionally uppercase
+- More specific patterns take precedence over general ones
+- Useful for handling special files like:
+  - `README.md` files (often contain badges, HTML, custom formatting)
+  - Generated documentation (API docs, changelogs)
+  - Table of contents files (`SUMMARY.md`, `TOC.md`)
+  - Legacy or third-party documentation
+- Combines with global `enable`/`disable` settings
+
+**Behavior**:
+
+1. Global rules are applied first
+2. Per-file ignores override global settings for matching files
+3. If a file matches multiple patterns, all ignores are combined
+
+**Example with precedence**:
+
+```toml
+[global]
+disable = ["MD013"]  # Disable line length globally
+
+[per-file-ignores]
+"README.md" = ["MD033", "MD041"]  # Also disable HTML and first-line heading for README
+"docs/**/*.md" = ["MD033"]  # Allow HTML in docs
+```
+
+Result:
+
+- `README.md`: MD013, MD033, MD041 disabled
+- `docs/guide.md`: MD013, MD033 disabled
+- `other.md`: MD013 disabled
+
+**Common Use Cases**:
+
+1. **MkDocs/mdBook Projects**:
+
+   ```toml
+   [per-file-ignores]
+   "SUMMARY.md" = ["MD025"]  # Table of contents has multiple H1 headings
+   ```
+
+2. **GitHub Projects with Badges**:
+
+   ```toml
+   [per-file-ignores]
+   "README.md" = ["MD033", "MD041"]  # Allow HTML badges, may not start with heading
+   ```
+
+3. **Generated Documentation**:
+
+   ```toml
+   [per-file-ignores]
+   "docs/api/**/*.md" = ["MD013", "MD024", "MD041"]  # Relax rules for generated files
+   ```
+
+4. **Mixed Documentation Sources**:
+
+   ```toml
+   [per-file-ignores]
+   "vendor/**/*.md" = ["MD013", "MD033", "MD041"]  # Third-party docs
+   "legacy/**/*.md" = ["MD003", "MD022", "MD032"]  # Old docs with different style
+   ```
+
 ### `exclude`
 
 **Type**: `string[]`

{rumdl-0.0.161 → 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.