rumdl 0.0.92__tar.gz → 0.0.93__tar.gz

{rumdl-0.0.92 → rumdl-0.0.93}/CHANGELOG.md

@@ -7,8 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.93] - 2025-07-03
+
 ## [0.0.92] - 2025-07-02
 
+### Fixed
+
+- MD036: Align with markdownlint behavior - emphasis ending with punctuation (e.g., `**Note:**`) is no longer flagged
+
 ## [0.0.91] - 2025-07-02
 
 ## [0.0.90] - 2025-07-01
@@ -16,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.0.89] - 2025-07-01
 
 ### Added
+
 - Comprehensive unit test coverage for all 54 linting rules (~742 new tests)
 - Unit tests for LSP server functionality
 - Unit tests for all 11 output formatters
@@ -23,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Test coverage improved from 75.4% to 77.1%
 
 ### Fixed
+
 - MD005: Fixed blockquote handling to correctly ignore intentional separations
 - MD054: Fixed overlapping match detection for link/image styles
 - Strong style utility module refactored to remove unused code
@@ -31,12 +39,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - MD013: Fixed line length calculation to intelligently handle URLs in non-strict mode
 
 ### Improved
+
 - Test infrastructure now includes both unit and integration tests
 - Better test organization with inline unit tests in implementation files
 
 ## [0.0.88] - 2025-06-28
 
 ### Added
+
 - 11 new output formatters for enhanced compatibility:
   - `grouped` - Groups violations by file
   - `pylint` - Pylint-compatible format
@@ -51,14 +61,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `text` - Default human-readable format with colors
 
 ### Changed
+
 - **BREAKING**: Upgraded to Rust 2024 edition (requires Rust 1.87.0+)
 - Improved code quality by fixing all 283 clippy warnings
 
 ### Fixed
+
 - Config `output_format` field now properly merges from configuration files
 - Pylint formatter now outputs correct `CMD` codes instead of generic `C` codes
 
 ### Optimized
+
 - Removed unused dependencies (`glob`, `walkdir`)
 - Reduced binary size with aggressive compilation flags (LTO, strip, opt-level=z)
 - Improved performance through better regex compilation and caching
@@ -72,12 +85,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.0.84] - 2025-06-10
 
 ### Added
+
 - Type-safe serde-based configuration system for all 24 configurable rules
 - Dedicated config modules for each rule with compile-time validation
 - Full IDE support with autocomplete for configuration options
 - Centralized utilities for common parsing patterns
 
 ### Changed
+
 - **BREAKING**: Internal configuration structure refactored (external API unchanged)
 - Migrated all rules from manual TOML parsing to serde deserialization
 - Improved performance through centralized parsing for:
@@ -89,9 +104,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - ~40% reduction in configuration boilerplate code
 
 ### Fixed
+
 - MD030: Correct handling of tab characters in list items
 
 ### Performance
+
 - Significant performance improvements across multiple rules through:
   - Centralized regex compilation and caching
   - Reduced redundant parsing operations
@@ -101,19 +118,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.0.83] - 2025-06-07
 
 ### Fixed
+
 - Various bug fixes and performance improvements
 
 ## [0.0.82] - 2025-06-06
 
 ### Fixed
+
 - Various bug fixes and stability improvements
 
 ## [0.0.81] - 2025-06-04
 
 ### Added
+
 - Initial implementation of remaining rules for markdownlint parity
 
-[Unreleased]: https://github.com/rvben/rumdl/compare/v0.0.92...HEAD
+[Unreleased]: https://github.com/rvben/rumdl/compare/v0.0.93...HEAD
+[0.0.93]: https://github.com/rvben/rumdl/compare/v0.0.92...v0.0.93
 [0.0.92]: https://github.com/rvben/rumdl/compare/v0.0.91...v0.0.92
 [0.0.91]: https://github.com/rvben/rumdl/compare/v0.0.90...v0.0.91
 [0.0.90]: https://github.com/rvben/rumdl/compare/v0.0.89...v0.0.90
@@ -125,4 +146,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.0.84]: https://github.com/rvben/rumdl/compare/v0.0.83...v0.0.84
 [0.0.83]: https://github.com/rvben/rumdl/compare/v0.0.82...v0.0.83
 [0.0.82]: https://github.com/rvben/rumdl/compare/v0.0.81...v0.0.82
-[0.0.81]: https://github.com/rvben/rumdl/releases/tag/v0.0.81
+[0.0.81]: https://github.com/rvben/rumdl/releases/tag/v0.0.81

{rumdl-0.0.92 → rumdl-0.0.93}/Cargo.lock

@@ -1465,7 +1465,7 @@ checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
 
 [[package]]
 name = "rumdl"
-version = "0.0.92"
+version = "0.0.93"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.92 → rumdl-0.0.93}/Cargo.toml

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

{rumdl-0.0.92 → rumdl-0.0.93}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.92
+Version: 0.0.93
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -66,7 +66,9 @@ rumdl init
 
 ## Overview
 
-rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices in your Markdown files. Inspired by [ruff](https://github.com/astral-sh/ruff)'s approach to Python linting, rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
+rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices
+in your Markdown files. Inspired by [ruff](https://github.com/astral-sh/ruff)'s approach to Python linting,
+rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
 
 It offers:
 
@@ -99,11 +101,11 @@ It offers:
 - [Configuration](#configuration)
   - [Configuration File Example](#configuration-file-example)
   - [Initializing Configuration](#initializing-configuration)
-  - [Configuration in pyproject.toml](#configuration-in-pyprojecttoml)
+  - [Configuration in pyproject.toml](#configuration-in-pyproject-toml)
   - [Configuration Output](#configuration-output)
     - [Effective Configuration (`rumdl config`)](#effective-configuration-rumdl-config)
     - [Example output](#example-output)
-  - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
+  - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config-defaults)
 - [Output Style](#output-style)
   - [Output Format](#output-format)
 - [Development](#development)

{rumdl-0.0.92 → rumdl-0.0.93}/README.md

@@ -35,7 +35,9 @@ rumdl init
 
 ## Overview
 
-rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices in your Markdown files. Inspired by [ruff](https://github.com/astral-sh/ruff)'s approach to Python linting, rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
+rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices
+in your Markdown files. Inspired by [ruff](https://github.com/astral-sh/ruff)'s approach to Python linting,
+rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
 
 It offers:
 
@@ -68,11 +70,11 @@ It offers:
 - [Configuration](#configuration)
   - [Configuration File Example](#configuration-file-example)
   - [Initializing Configuration](#initializing-configuration)
-  - [Configuration in pyproject.toml](#configuration-in-pyprojecttoml)
+  - [Configuration in pyproject.toml](#configuration-in-pyproject-toml)
   - [Configuration Output](#configuration-output)
     - [Effective Configuration (`rumdl config`)](#effective-configuration-rumdl-config)
     - [Example output](#example-output)
-  - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
+  - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config-defaults)
 - [Output Style](#output-style)
   - [Output Format](#output-format)
 - [Development](#development)

{rumdl-0.0.92 → rumdl-0.0.93}/docs/global-settings.md

@@ -4,7 +4,8 @@ This document provides a comprehensive reference for rumdl's global configuratio
 
 ## Overview
 
-Global settings are configured in the `[global]` section of your configuration file (`.rumdl.toml` or `pyproject.toml`). These settings control file selection, rule enablement, and general linting behavior.
+Global settings are configured in the `[global]` section of your configuration file (`.rumdl.toml` or
+`pyproject.toml`). These settings control file selection, rule enablement, and general linting behavior.
 
 ## Quick Reference
 

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md003.md

@@ -30,6 +30,32 @@ Second Level Heading
 ------------------
 ```
 
+### ✅ Correct (using setext_with_atx style)
+
+```markdown
+First Level Heading
+==================
+
+Second Level Heading
+------------------
+
+### Third Level Heading
+#### Fourth Level Heading
+```
+
+### ✅ Correct (using setext_with_atx_closed style)
+
+```markdown
+First Level Heading
+==================
+
+Second Level Heading
+------------------
+
+### Third Level Heading ###
+#### Fourth Level Heading ####
+```
+
 ### ❌ Incorrect (mixed styles)
 
 <!-- rumdl-disable MD003 -->
@@ -57,7 +83,7 @@ Second Level Heading
 
 ```yaml
 MD003:
-  style: "consistent"  # Options: "consistent", "atx", "atx_closed", "setext"
+  style: "consistent"  # Options: "consistent", "atx", "atx_closed", "setext", "setext_with_atx", "setext_with_atx_closed"
 ```
 
 ### Style options explained
@@ -66,6 +92,8 @@ MD003:
 - `"atx"`: Use # symbols (`# Heading`)
 - `"atx_closed"`: Use # symbols at both ends (`# Heading #`)
 - `"setext"`: Use underlines (equals for level 1, dashes for level 2)
+- `"setext_with_atx"`: Use underlines for level 1-2, # symbols for level 3-6
+- `"setext_with_atx_closed"`: Use underlines for level 1-2, # symbols with closing # for level 3-6
 
 > **Note**: Underline style only works for level 1 and 2 headings. Level 3 and below must use # symbols.
 

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md004.md

@@ -33,6 +33,19 @@ Ensures all unordered lists use the same marker (* or + or -) throughout your do
 - Item 3
 ```
 
+### ✅ Correct (using sublist style)
+
+```markdown
+* Item 1
+* Item 2
+  + Nested item 1
+  + Nested item 2
+    - Deep nested item 1
+    - Deep nested item 2
+      * Even deeper (cycles back to *)
+* Item 3
+```
+
 ### ❌ Incorrect
 
 ```markdown
@@ -57,7 +70,7 @@ Ensures all unordered lists use the same marker (* or + or -) throughout your do
 
 ```yaml
 MD004:
-  style: "consistent"  # Options: "consistent", "asterisk", "plus", "dash"
+  style: "consistent"  # Options: "consistent", "asterisk", "plus", "dash", "sublist"
 ```
 
 ### Style options
@@ -66,6 +79,7 @@ MD004:
 - `"asterisk"`: Always use * markers
 - `"plus"`: Always use + markers  
 - `"dash"`: Always use - markers
+- `"sublist"`: Each nesting level uses a different marker (cycles through *, +, -)
 
 ## Automatic fixes
 

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md007.md

@@ -56,7 +56,35 @@ Ensures nested list items are indented with exactly 2 spaces per level for consi
 
 ```yaml
 MD007:
-  indent: 2  # Number of spaces per indentation level (default: 2)
+  indent: 2               # Number of spaces per indentation level (default: 2)
+  start_indented: false   # Allow first level lists to start indented (default: false)
+  start_indent: 2         # Number of spaces for first level when start_indented is true (default: 2)
+```
+
+### Configuration options explained
+
+- `indent`: The number of spaces to use for each level of list nesting
+- `start_indented`: When `true`, allows the first level of lists to be indented instead of starting at column 0
+- `start_indent`: When `start_indented` is `true`, this specifies how many spaces the first level should be indented
+
+### Example with start_indented: true
+
+```yaml
+MD007:
+  indent: 2
+  start_indented: true
+  start_indent: 4
+```
+
+With this configuration, the following is valid:
+
+```markdown
+Some paragraph text.
+
+    * First level item (4 spaces indent)
+      * Second level item (6 spaces total: 4 + 2)
+        * Third level item (8 spaces total: 4 + 2 + 2)
+    * Another first level item
 ```
 
 ## Automatic fixes

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md010.md

@@ -63,10 +63,46 @@ Replaces tab characters with spaces to ensure consistent indentation across all
 
 ```yaml
 MD010:
-  code_blocks: true      # Check for tabs in code blocks (default: true)
-  spaces_per_tab: 4      # Number of spaces to replace each tab with (default: 4)
+  code_blocks: true                     # Check for tabs in code blocks (default: true)
+  spaces_per_tab: 4                     # Number of spaces to replace each tab with (default: 4)
+  ignore_code_languages: []             # List of code languages to ignore (default: [])
 ```
 
+### Configuration options explained
+
+- `code_blocks`: Whether to check for tabs inside code blocks
+- `spaces_per_tab`: How many spaces to use when replacing each tab character
+- `ignore_code_languages`: List of code block languages where tabs are allowed (useful for languages like Makefile where tabs are required)
+
+### Example with ignored languages
+
+```yaml
+MD010:
+  code_blocks: true
+  spaces_per_tab: 4
+  ignore_code_languages:
+    - makefile
+    - make
+    - Makefile
+    - go.mod
+```
+
+With this configuration, tabs will be allowed in code blocks marked with these languages:
+
+````markdown
+```makefile
+# Tabs are required in Makefiles
+target:
+	command with tab
+```
+
+```python
+# Tabs will be replaced with spaces here
+def function():
+	return value
+```
+````
+
 ## Automatic fixes
 
 This rule automatically replaces each tab character with the configured number of spaces (default: 4). This ensures your document looks the same in every editor.

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md013.md

@@ -47,10 +47,53 @@ and work with in various contexts.
 
 ```yaml
 MD013:
-  line_length: 100        # Maximum characters per line (default: 80)
-  code_blocks: false      # Don't check code blocks (default: true)
-  tables: false           # Don't check tables (default: true)
-  headings: true          # Check headings (default: true)
+  line_length: 100              # Maximum characters per line (default: 80)
+  code_blocks: false            # Don't check code blocks (default: true)
+  tables: false                 # Don't check tables (default: true)
+  headings: true                # Check headings (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)
+  strict: false                 # Disables exceptions for URLs, etc. (default: false)
+```
+
+### Configuration options explained
+
+- `line_length`: The maximum number of characters allowed per line
+- `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
+- `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
+- `strict`: When true, disables exceptions for URLs and other special content
+
+### Example with different limits
+
+```yaml
+MD013:
+  line_length: 80
+  heading_line_length: 100
+  code_block_line_length: 120
+  code_blocks: true
+  headings: true
+```
+
+With this configuration:
+- Regular text must stay within 80 characters
+- Headings can extend up to 100 characters
+- Code blocks can have lines up to 120 characters
+
+```markdown
+This regular paragraph text must wrap at 80 characters to comply with the rule.
+
+## This heading can be longer and extend up to 100 characters without triggering a warning
+
+```python
+# This code block can have longer lines up to 120 characters
+def very_long_function_name_that_demonstrates_the_code_block_line_length_configuration_option():
+    pass
+```
 ```
 
 ## Automatic fixes

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md018.md

@@ -53,6 +53,13 @@ Ensures there's a space between the # symbols and the heading text.
 
 This rule has no configuration options.
 
+## Special cases
+
+This rule correctly handles:
+- Emoji hashtags like #️⃣ and #⃣ (not treated as headings)
+- Regular hashtags like #tag or #123 (not treated as headings)
+- Only actual heading syntax triggers this rule
+
 ## Automatic fixes
 
 This rule automatically adds a space after the # symbols to properly format the heading.

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md040.md

@@ -31,7 +31,7 @@ echo "Hello, world!"
 
 ### ❌ Incorrect
 
-<!-- rumdl-disable MD040 -->
+<!-- rumdl-disable MD040 MD031 -->
 
 ````markdown
 ```
@@ -44,7 +44,7 @@ console.log("Hello, world!");
 ```
 ````
 
-<!-- rumdl-enable MD040 -->
+<!-- rumdl-enable MD040 MD031 -->
 
 ### 🔧 Fixed
 

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md041.md

@@ -27,6 +27,14 @@ Welcome to our documentation! This guide will help you...
 This project provides tools for...
 ```
 
+Also correct with HTML headings:
+
+```markdown
+<h1>Getting Started Guide</h1>
+
+Welcome to our documentation! This guide will help you...
+```
+
 ### ❌ Incorrect  
 
 ```markdown
@@ -61,6 +69,7 @@ First, install the dependencies...
 MD041:
   level: 1                    # Heading level required (1-6, default: 1)
   front_matter_title: "title" # Front matter field to use as title
+  front_matter_title_pattern: "^(title|header):" # Regex pattern to match title fields in front matter
 ```
 
 ## Automatic fixes
@@ -74,6 +83,8 @@ When enabled, this rule will:
 - Documents with front matter containing a title field are considered valid
 - Empty documents are not checked
 - HTML comments at the start are ignored when checking
+- HTML heading tags (e.g., `<h1>Title</h1>`) are recognized as valid headings
+- The `front_matter_title_pattern` allows custom regex patterns for matching title fields
 
 ## Learn more
 

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md046.md

@@ -35,6 +35,8 @@ And here's the response format:
 
 ### ❌ Incorrect (Mixed styles)
 
+<!-- rumdl-disable MD031 MD040 -->
+
 ````markdown
 Here's how to use our API:
 
@@ -51,6 +53,8 @@ And here's the response format:
     }
 ````
 
+<!-- rumdl-enable MD031 MD040 -->
+
 ### 🔧 Fixed
 
 ````markdown

{rumdl-0.0.92 → rumdl-0.0.93}/docs/md048.md

@@ -44,7 +44,7 @@ def hello():
 
 ### ❌ Incorrect (mixed styles)
 
-<!-- rumdl-disable MD048 -->
+<!-- rumdl-disable MD048 MD031 MD040 -->
 
 ````markdown
 ```javascript
@@ -59,7 +59,7 @@ def hello():
 ~~~
 ````
 
-<!-- rumdl-enable MD048 -->
+<!-- rumdl-enable MD048 MD031 MD040 -->
 
 ### 🔧 Fixed
 

{rumdl-0.0.92 → rumdl-0.0.93}/docs/vscode-extension.md

@@ -1,6 +1,8 @@
 # Rumdl VS Code Extension
 
-The rumdl VS Code extension provides real-time Markdown linting directly in your editor, powered by the same fast Rust-based engine as the rumdl CLI. With the new `rumdl vscode` command, you can install and manage the extension directly from your terminal.
+The rumdl VS Code extension provides real-time Markdown linting directly in your editor, powered by the
+same fast Rust-based engine as the rumdl CLI. With the new `rumdl vscode` command, you can install and
+manage the extension directly from your terminal.
 
 ## Installation
 
@@ -64,18 +66,21 @@ The extension will automatically detect and use your project's `.rumdl.toml` con
 ### Extension Not Working
 
 1. Check if the extension is installed:
+
    ```bash
    rumdl vscode --status
    ```
 
 2. Ensure VS Code's `code` command is in your PATH:
-   - On macOS: Open VS Code, press Cmd+Shift+P, and run "Shell Command: Install 'code' command in PATH"
-   - On Windows: This should be automatic during VS Code installation
-   - On Linux: Add VS Code's bin directory to your PATH
+
+- On macOS: Open VS Code, press Cmd+Shift+P, and run "Shell Command: Install 'code' command in PATH"
+- On Windows: This should be automatic during VS Code installation
+- On Linux: Add VS Code's bin directory to your PATH
 
 3. Check the extension logs:
-   - Open VS Code's Output panel (View → Output)
-   - Select "rumdl" from the dropdown
+
+- Open VS Code's Output panel (View → Output)
+- Select "rumdl" from the dropdown
 
 ### VS Code Not Found
 
@@ -83,6 +88,7 @@ If you get a "VS Code not found" error, make sure:
 
 1. VS Code is installed
 2. The `code` command is available in your terminal:
+
    ```bash
    code --version
    ```
@@ -91,4 +97,4 @@ If you get a "VS Code not found" error, make sure:
 
 - [rumdl GitHub Repository](https://github.com/rvben/rumdl)
 - [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=rumdl.rumdl)
-- [Configuration Guide](./global-settings.md)
+- [Configuration Guide](./global-settings.md)