rumdl 0.0.156__tar.gz → 0.0.158__tar.gz

{rumdl-0.0.156 → rumdl-0.0.158}/CHANGELOG.md

@@ -7,6 +7,240 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.158] - 2025-10-14
+
+### Fixed
+
+- **CRLF Line Ending Support**: Fixed byte position calculations in multiple rules for Windows-style line endings
+  - Fixed MD034, MD046, MD057 byte position calculations
+  - Fixed MD037, MD049, MD011 byte position calculations
+  - Fixed MD050, MD037, MD010, MD026 byte position calculations
+  - Fixed code_block_utils byte position calculation in `is_in_code_span`
+  - All rules now correctly handle CRLF line endings in fixes and diagnostics
+
+- **Test Stability**: Fixed flaky tests with dependency injection pattern
+  - Eliminated race conditions from parallel test execution
+  - Tests no longer modify global environment variables
+  - Added `serial_test` crate for unavoidable global operations
+  - All 1731 tests now pass reliably in parallel execution
+
+### Changed
+
+- **Code Architecture**: Major refactoring to improve maintainability
+  - Extracted `formatter` module (397 lines) - output formatting logic
+  - Extracted `watch` module (491 lines) - watch mode functionality
+  - Extracted `file_processor` module (792 lines) - file processing logic
+  - Extracted `stdin_processor` module (212 lines) - stdin handling
+  - main.rs reduced from 3268 to 1394 lines (57% reduction)
+  - Improved code organization and testability
+
+- **Line Ending Handling**: Refactored line ending preservation
+  - Line ending detection and normalization now at I/O boundaries
+  - Internal code always works with consistent LF line endings
+  - More efficient: 1 normalization per file instead of per-rule
+  - Cleaner separation of concerns
+  - Simplified MD047, MD012, MD022 to always use LF internally
+  - Removed unnecessary line ending detection from rules
+  - Added comprehensive end-to-end CRLF tests
+
+### Removed
+
+- **Legacy Fix Implementation**: Removed deprecated fix wrapper functions
+  - Removed `apply_fixes()` wrapper
+  - Removed `apply_fixes_stdin_coordinated()` wrapper
+  - Removed `apply_fixes_stdin()` legacy implementation
+  - Removed `RUMDL_NO_FIX_COORDINATOR` environment variable
+  - Fix Coordinator is now the only fix strategy (3 weeks stable, ~75% faster)
+
+## [0.0.157] - 2025-10-13
+
+### Changed
+
+- **Removed legacy fix implementation** - Removed old single-pass fix implementation and `RUMDL_NO_FIX_COORDINATOR` environment variable. Fix Coordinator is now the only fix strategy, providing ~75% faster fixes with better coverage.
+
+### Added
+
+- **MD042**: Full support for MkDocs paragraph anchors (#100)
+  - Recognize Python-Markdown `attr_list` extension syntax: `[](){ #anchor }`
+  - Support for both anchor IDs (`#id`) and CSS classes (`.class`)
+  - Support optional colon syntax: `[](){: #anchor }`
+  - UTF-8 boundary validation and DoS prevention (500 char limit)
+  - 28 comprehensive tests covering edge cases
+  - Complete documentation with links to official Python-Markdown specs
+  - References: [attr_list](https://python-markdown.github.io/extensions/attr_list/), [mkdocs-autorefs](https://mkdocstrings.github.io/autorefs/)
+
+- **MD042**: Smart URL detection in empty links (#104)
+  - When link text looks like a URL (e.g., `[https://example.com]()`), use it as the destination
+  - Supports http://, https://, ftp://, ftps:// protocols
+  - More intelligent fixes than placeholder URLs
+
+- **Always respect exclude patterns by default** (#99)
+  - Exclude patterns now always respected, even for explicitly provided files
+  - Matches behavior of ESLint, Pylint, Mypy
+  - Added `--no-exclude` flag to disable all exclusions when needed
+  - LSP support for exclude patterns
+  - Shows warnings with actionable hints when excluding files
+
+- **Hidden directory scanning** (#102)
+  - Now scans hidden directories (like `.documentation`) by default
+  - More thorough markdown file discovery
+
+### Fixed
+
+- **MD033**: Code blocks in blockquotes false positives (#105)
+  - Fixed incorrect flagging of HTML tags inside fenced code blocks within blockquotes
+  - Properly strips blockquote markers before detecting fence markers
+  - 25 new tests covering nested blockquotes and edge cases
+
+- **MD034**: Empty link construct false positives (#104)
+  - Fixed incorrect flagging of URLs in `[url]()` and `[url][]` patterns
+  - Prevents text corruption during formatting
+  - Added patterns to properly exclude empty link constructs
+
+- **MD042**: Improved fix quality
+  - Removed "useless" placeholder fixes that just create new problems
+  - Only provides fixes when we have enough information for valid links
+  - No longer auto-fixes `[]()` or `[text]()` with placeholders
+
+### Changed
+
+- **BREAKING**: Exclude patterns now always respected by default
+  - Previously: `--force-exclude` flag needed to respect excludes for explicit files
+  - Now: Excludes always respected by default
+  - Migration: Use `--no-exclude` flag if you need the old behavior
+
+## [0.0.156] - 2025-10-08
+
+### Fixed
+
+- **Build**: Removed feature-gated benchmark binaries that were causing unnecessary reinstalls
+  - Benchmark binaries now only built when explicitly requested
+  - Reduces package size and installation time
+
+## [0.0.155] - 2025-10-08
+
+### Fixed
+
+- **PyPI Package**: Fixed package structure by removing unused cdylib and dependencies
+  - Removed unnecessary C dynamic library configuration
+  - Cleaner Python package distribution
+
+## [0.0.154] - 2025-10-08
+
+### Fixed
+
+- **MD013**: Implemented segment-based reflow to preserve hard breaks
+  - Properly handles double-space line breaks
+  - Integration tests updated for new behavior
+
+### Performance
+
+- **MD034**: Reuse buffers to reduce per-line allocations
+- **MD005**: Eliminate LineIndex creation overhead
+- **MD030**: Eliminate O(n²) complexity by caching line collection
+
+### Documentation
+
+- Organized LintContext optimization documentation
+
+## [0.0.153] - 2025-10-07
+
+### Performance
+
+- **Major optimization**: 54 rules now use LintContext character frequency caching
+  - Significant performance improvement across the board
+  - Reduced redundant scanning of document content
+
+- **MD051**: Optimized link fragment validation
+  - Faster processing of heading anchors and fragments
+
+### Fixed
+
+- **MD013**: Improved nested list handling in reflow mode
+  - Better preservation of list structure during reformatting
+
+## [0.0.152] - 2025-10-06
+
+### Fixed
+
+- **MD013**: Multi-paragraph list reflow improvements and refactoring
+  - Better handling of complex list structures
+  - More reliable paragraph detection within lists
+
+## [0.0.151] - 2025-10-05
+
+### Fixed
+
+- **MD007**: Fixed tab indentation and cascade behavior
+  - Properly handles tabs in list indentation
+  - Correct cascade behavior matching markdownlint
+
+## [0.0.150] - 2025-10-04
+
+### Fixed
+
+- **MD007**: Multiple fixes for list indentation
+  - Correct blockquote list handling
+  - Fixed text-aligned indentation to match markdownlint cascade behavior
+  - Updated test expectations for cascade behavior
+
+## [0.0.149] - 2025-10-03
+
+### Added
+
+- **Configuration**: JSON Schema for rumdl.toml configuration (#89)
+  - IDE autocomplete and validation support
+  - Better configuration documentation
+
+- **Configuration**: Per-file rule ignores (#92)
+  - Glob pattern support for ignoring rules on specific files
+  - Example: `[per-file-ignores] "docs/*.md" = ["MD013"]`
+
+## [0.0.148] - 2025-10-02
+
+### Fixed
+
+- **MD042**: Display improvements
+  - Show exact source text in error messages
+  - Correct display of shorthand reference links
+
+- **MkDocs**: Strip backticks from MkDocs auto-references (#97)
+  - Prevents false positives on `` [`module.Class`][] `` patterns
+
+## [0.0.147] - 2025-10-01
+
+### Added
+
+- **MkDocs**: Added mkdocstrings support (#94)
+  - Recognizes mkdocstrings YAML options
+  - Multiple rules migrated to use LintContext for better MkDocs handling
+
+### Fixed
+
+- **MD041**: Removed auto-fix capability (#93)
+  - Auto-fixing front-heading violations was unreliable
+  - Now only reports issues without attempting fixes
+
+- **MD026**: Corrected documentation to match implementation (#95)
+  - Documentation now accurately reflects punctuation handling
+
+- **Jinja2**: Added Jinja2 template support (#96)
+  - Prevents false positives in template syntax
+  - Better support for MkDocs projects using Jinja2
+
+- **MD013**: Prevent false positives for already-reflowed content
+  - Smarter detection of intentional line breaks
+
+- **MD034**: Properly excludes URLs/emails in code spans and HTML
+  - No more false positives on inline code URLs
+
+- **MD054**: Fixed column indexing bug
+  - Correct error position reporting
+
+- **MD033 & MD032**: Resolved false positives (#90, #91)
+  - More accurate HTML tag detection
+  - Better handling of code blocks
+
 ## [0.0.146] - 2025-09-24
 
 ### Added

{rumdl-0.0.156 → rumdl-0.0.158}/Cargo.lock

@@ -586,6 +586,7 @@ checksum = "65bc07b1a8bc7c85c5f2e110c476c7389b4554ba72af57d8445ea63a576b0876"
 dependencies = [
  "futures-channel",
  "futures-core",
+ "futures-executor",
  "futures-io",
  "futures-sink",
  "futures-task",
@@ -608,6 +609,17 @@ version = "0.3.31"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "05f29059c0c2090612e8d742178b0580d2dc940c837851ad723096f87af6663e"
 
+[[package]]
+name = "futures-executor"
+version = "0.3.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e28d1d997f585e54aebc3f97d39e72338912123a67330d723fdbb564d646c9f"
+dependencies = [
+ "futures-core",
+ "futures-task",
+ "futures-util",
+]
+
 [[package]]
 name = "futures-io"
 version = "0.3.31"
@@ -1566,7 +1578,7 @@ checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001"
 
 [[package]]
 name = "rumdl"
-version = "0.0.156"
+version = "0.0.158"
 dependencies = [
  "anyhow",
  "assert_cmd",
@@ -1600,6 +1612,7 @@ dependencies = [
  "serde",
  "serde_json",
  "serde_yaml",
+ "serial_test",
  "strsim",
  "tempfile",
  "thiserror",
@@ -1669,6 +1682,15 @@ dependencies = [
  "winapi-util",
 ]
 
+[[package]]
+name = "scc"
+version = "2.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "46e6f046b7fef48e2660c57ed794263155d713de679057f2d0c169bfc6e756cc"
+dependencies = [
+ "sdd",
+]
+
 [[package]]
 name = "schemars"
 version = "0.8.22"
@@ -1699,6 +1721,12 @@ version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
 
+[[package]]
+name = "sdd"
+version = "3.0.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "490dcfcbfef26be6800d11870ff2df8774fa6e86d047e3e8c8a76b25655e41ca"
+
 [[package]]
 name = "serde"
 version = "1.0.226"
@@ -1786,6 +1814,31 @@ dependencies = [
  "unsafe-libyaml",
 ]
 
+[[package]]
+name = "serial_test"
+version = "3.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b258109f244e1d6891bf1053a55d63a5cd4f8f4c30cf9a1280989f80e7a1fa9"
+dependencies = [
+ "futures",
+ "log",
+ "once_cell",
+ "parking_lot",
+ "scc",
+ "serial_test_derive",
+]
+
+[[package]]
+name = "serial_test_derive"
+version = "3.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5d69265a08751de7844521fd15003ae0a888e035773ba05695c5c759a6f89eef"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "shlex"
 version = "1.3.0"

{rumdl-0.0.156 → rumdl-0.0.158}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.156"
+version = "0.0.158"
 edition = "2024"
 rust-version = "1.89.0"
 description = "A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)"
@@ -103,6 +103,7 @@ rand = "0.9.1"
 pretty_assertions = "1.4"
 unicode-segmentation = "1.12"
 unicode-width = "0.2"
+serial_test = "3.2"
 
 [target.'cfg(not(target_env = "msvc"))'.dependencies]
 tikv-jemallocator = "0.6"

{rumdl-0.0.156 → rumdl-0.0.158}/PKG-INFO

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

{rumdl-0.0.156 → rumdl-0.0.158}/docs/md042.md

@@ -67,6 +67,34 @@ When enabled, this rule will:
 - Reference-style links are checked for both parts
 - Links with only whitespace are considered empty
 
+### MkDocs mode
+
+When using MkDocs flavor (`flavor = "mkdocs"`), this rule recognizes valid MkDocs-specific syntax:
+
+**Auto-references** (backtick-wrapped Python identifiers):
+
+```markdown
+[`module.Class`][]        <!-- Valid MkDocs auto-reference -->
+[`str`][]                 <!-- Valid Python type reference -->
+[`api.function`][]        <!-- Valid API reference -->
+```
+
+**Paragraph anchors** (using Python-Markdown attr_list extension):
+
+```markdown
+[](){ #my-anchor }        <!-- Valid anchor point -->
+[](){ #anchor .class }    <!-- Valid anchor with CSS class -->
+[](){: #anchor }          <!-- Valid with colon syntax -->
+```
+
+These patterns create anchor points in documentation and are widely used in MkDocs projects with the `attr_list` extension.
+
+**References:**
+
+- [Python-Markdown attr_list extension](https://python-markdown.github.io/extensions/attr_list/)
+- [mkdocs-autorefs plugin](https://mkdocstrings.github.io/autorefs/)
+- [MkDocs auto-references discussion](https://github.com/mkdocs/mkdocs/discussions/3754)
+
 ## Learn more
 
 - [CommonMark specification for links](https://spec.commonmark.org/0.31.2/#links)

{rumdl-0.0.156 → rumdl-0.0.158}/src/config.rs

@@ -251,11 +251,12 @@ pub struct GlobalConfig {
     #[serde(default)]
     pub flavor: MarkdownFlavor,
 
-    /// Whether to enforce exclude and extend-exclude patterns even for paths that are passed explicitly.
-    /// By default (false), rumdl will lint any paths passed in directly, even if they would typically be excluded.
-    /// Setting this to true will cause rumdl to respect exclusions unequivocally.
-    /// This is useful for pre-commit, which explicitly passes all changed files.
+    /// [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.
     #[serde(default)]
+    #[deprecated(since = "0.0.156", note = "Exclude patterns are now always respected")]
     pub force_exclude: bool,
 }
 
@@ -269,6 +270,7 @@ fn default_line_length() -> u64 {
 
 // Add the Default impl
 impl Default for GlobalConfig {
+    #[allow(deprecated)]
     fn default() -> Self {
         Self {
             enable: Vec::new(),
@@ -1704,52 +1706,55 @@ impl SourcedConfig {
         None
     }
 
-    /// Discover user-level configuration file from platform-specific config directory.
-    /// Returns the first configuration file found in the user config directory.
-    fn user_configuration_path() -> Option<std::path::PathBuf> {
-        use etcetera::{BaseStrategy, choose_base_strategy};
+    /// Internal implementation that accepts config directory for testing
+    fn user_configuration_path_impl(config_dir: &Path) -> Option<std::path::PathBuf> {
+        let config_dir = config_dir.join("rumdl");
 
-        match choose_base_strategy() {
-            Ok(strategy) => {
-                let config_dir = strategy.config_dir().join("rumdl");
+        // Check for config files in precedence order (same as project discovery)
+        const USER_CONFIG_FILES: &[&str] = &[".rumdl.toml", "rumdl.toml", "pyproject.toml"];
 
-                // Check for config files in precedence order (same as project discovery)
-                const USER_CONFIG_FILES: &[&str] = &[".rumdl.toml", "rumdl.toml", "pyproject.toml"];
+        log::debug!(
+            "[rumdl-config] Checking for user configuration in: {}",
+            config_dir.display()
+        );
 
-                log::debug!(
-                    "[rumdl-config] Checking for user configuration in: {}",
-                    config_dir.display()
-                );
+        for filename in USER_CONFIG_FILES {
+            let config_path = config_dir.join(filename);
 
-                for filename in USER_CONFIG_FILES {
-                    let config_path = config_dir.join(filename);
-
-                    if config_path.exists() {
-                        // For pyproject.toml, verify it contains [tool.rumdl] section
-                        if *filename == "pyproject.toml" {
-                            if let Ok(content) = std::fs::read_to_string(&config_path) {
-                                if content.contains("[tool.rumdl]") || content.contains("tool.rumdl") {
-                                    log::debug!(
-                                        "[rumdl-config] Found user configuration at: {}",
-                                        config_path.display()
-                                    );
-                                    return Some(config_path);
-                                }
-                                log::debug!("[rumdl-config] Found user pyproject.toml but no [tool.rumdl] section");
-                                continue;
-                            }
-                        } else {
+            if config_path.exists() {
+                // For pyproject.toml, verify it contains [tool.rumdl] section
+                if *filename == "pyproject.toml" {
+                    if let Ok(content) = std::fs::read_to_string(&config_path) {
+                        if content.contains("[tool.rumdl]") || content.contains("tool.rumdl") {
                             log::debug!("[rumdl-config] Found user configuration at: {}", config_path.display());
                             return Some(config_path);
                         }
+                        log::debug!("[rumdl-config] Found user pyproject.toml but no [tool.rumdl] section");
+                        continue;
                     }
+                } else {
+                    log::debug!("[rumdl-config] Found user configuration at: {}", config_path.display());
+                    return Some(config_path);
                 }
+            }
+        }
 
-                log::debug!(
-                    "[rumdl-config] No user configuration found in: {}",
-                    config_dir.display()
-                );
-                None
+        log::debug!(
+            "[rumdl-config] No user configuration found in: {}",
+            config_dir.display()
+        );
+        None
+    }
+
+    /// Discover user-level configuration file from platform-specific config directory.
+    /// Returns the first configuration file found in the user config directory.
+    fn user_configuration_path() -> Option<std::path::PathBuf> {
+        use etcetera::{BaseStrategy, choose_base_strategy};
+
+        match choose_base_strategy() {
+            Ok(strategy) => {
+                let config_dir = strategy.config_dir();
+                Self::user_configuration_path_impl(&config_dir)
             }
             Err(e) => {
                 log::debug!("[rumdl-config] Failed to determine user config directory: {e}");
@@ -1758,12 +1763,13 @@ impl SourcedConfig {
         }
     }
 
-    /// Load and merge configurations from files and CLI overrides.
-    /// If skip_auto_discovery is true, only explicit config paths are loaded.
-    pub fn load_with_discovery(
+    /// Internal implementation that accepts user config directory for testing
+    #[doc(hidden)]
+    pub fn load_with_discovery_impl(
         config_path: Option<&str>,
         cli_overrides: Option<&SourcedGlobalConfig>,
         skip_auto_discovery: bool,
+        user_config_dir: Option<&Path>,
     ) -> Result<Self, ConfigError> {
         use std::env;
         log::debug!("[rumdl-config] Current working directory: {:?}", env::current_dir());
@@ -1829,7 +1835,13 @@ impl SourcedConfig {
         // Only perform auto-discovery if not skipped AND no explicit config path provided
         if !skip_auto_discovery && config_path.is_none() {
             // Step 1: Load user configuration first (as a base)
-            if let Some(user_config_path) = Self::user_configuration_path() {
+            let user_config_path = if let Some(dir) = user_config_dir {
+                Self::user_configuration_path_impl(dir)
+            } else {
+                Self::user_configuration_path()
+            };
+
+            if let Some(user_config_path) = user_config_path {
                 let path_str = user_config_path.display().to_string();
                 let filename = user_config_path.file_name().and_then(|n| n.to_str()).unwrap_or("");
 
@@ -1948,6 +1960,16 @@ impl SourcedConfig {
 
         Ok(sourced_config)
     }
+
+    /// Load and merge configurations from files and CLI overrides.
+    /// If skip_auto_discovery is true, only explicit config paths are loaded.
+    pub fn load_with_discovery(
+        config_path: Option<&str>,
+        cli_overrides: Option<&SourcedGlobalConfig>,
+        skip_auto_discovery: bool,
+    ) -> Result<Self, ConfigError> {
+        Self::load_with_discovery_impl(config_path, cli_overrides, skip_auto_discovery, None)
+    }
 }
 
 impl From<SourcedConfig> for Config {
@@ -1962,6 +1984,7 @@ impl From<SourcedConfig> for Config {
             }
             rules.insert(normalized_rule_name, RuleConfig { values });
         }
+        #[allow(deprecated)]
         let global = GlobalConfig {
             enable: sourced.global.enable.value,
             disable: sourced.global.disable.value,