rumdl 0.0.161__tar.gz → 0.0.162__tar.gz

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

@@ -7,6 +7,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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

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

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.161
+Version: 0.0.162
 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)
 
@@ -726,6 +726,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.162}/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)
 
@@ -697,6 +697,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.162}/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[]`