rumdl 0.0.143__tar.gz → 0.0.144__tar.gz

{rumdl-0.0.143 → rumdl-0.0.144}/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.144] - 2025-09-22
+
 ## [0.0.142] - 2025-09-20
 
 ### Fixed
@@ -723,7 +725,8 @@ 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.142...HEAD
+[Unreleased]: https://github.com/rvben/rumdl/compare/v0.0.144...HEAD
+[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
 [0.0.138]: https://github.com/rvben/rumdl/compare/v0.0.137...v0.0.138

{rumdl-0.0.143 → rumdl-0.0.144}/Cargo.lock

@@ -1425,9 +1425,9 @@ dependencies = [
 
 [[package]]
 name = "proptest"
-version = "1.7.0"
+version = "1.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6fcdab19deb5195a31cf7726a210015ff1496ba1464fd42cb4f537b8b01b471f"
+checksum = "2bb0be07becd10686a0bb407298fb425360a5c44a663774406340c59a22de4ce"
 dependencies = [
  "bit-set",
  "bit-vec",
@@ -1644,7 +1644,7 @@ checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001"
 
 [[package]]
 name = "rumdl"
-version = "0.0.143"
+version = "0.0.144"
 dependencies = [
  "anyhow",
  "assert_cmd",
@@ -1764,9 +1764,9 @@ checksum = "1c107b6f4780854c8b126e228ea8869f4d7b71260f962fefb57b996b8959ba6b"
 
 [[package]]
 name = "serde"
-version = "1.0.225"
+version = "1.0.226"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fd6c24dee235d0da097043389623fb913daddf92c76e9f5a1db88607a0bcbd1d"
+checksum = "0dca6411025b24b60bfa7ec1fe1f8e710ac09782dca409ee8237ba74b51295fd"
 dependencies = [
  "serde_core",
  "serde_derive",
@@ -1774,18 +1774,18 @@ dependencies = [
 
 [[package]]
 name = "serde_core"
-version = "1.0.225"
+version = "1.0.226"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "659356f9a0cb1e529b24c01e43ad2bdf520ec4ceaf83047b83ddcc2251f96383"
+checksum = "ba2ba63999edb9dac981fb34b3e5c0d111a69b0924e253ed29d83f7c99e966a4"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.225"
+version = "1.0.226"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0ea936adf78b1f766949a4977b91d2f5595825bd6ec079aa9543ad2685fc4516"
+checksum = "8db53ae22f34573731bafa1db20f04027b2d25e02d8205921b569171699cdb33"
 dependencies = [
  "proc-macro2",
  "quote",

{rumdl-0.0.143 → rumdl-0.0.144}/Cargo.toml

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

{rumdl-0.0.143 → rumdl-0.0.144}/PKG-INFO

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

{rumdl-0.0.143 → rumdl-0.0.144}/docs/global-settings.md

@@ -87,6 +87,7 @@ enable = ["MD001", "MD003", "MD013", "MD022"]
 ```
 
 **Usage Notes**:
+
 - Rule IDs are case-insensitive but conventionally uppercase (e.g., "MD001")
 - If both `enable` and `disable` are specified, `enable` takes precedence
 - An empty array means all rules are enabled (default behavior)
@@ -112,6 +113,7 @@ disable = ["MD013", "MD033", "MD041"]
 ```
 
 **Usage Notes**:
+
 - Rule IDs are case-insensitive but conventionally uppercase
 - Commonly disabled rules include:
   - `MD013`: Line length (for projects with longer lines)
@@ -146,12 +148,14 @@ exclude = [
 ```
 
 **Supported Patterns**:
+
 - `directory/` - Exclude entire directory
 - `**/*.ext` - Exclude all files with extension in any subdirectory
 - `*.pattern` - Exclude files matching pattern in current directory
 - `path/**/file` - Exclude specific files in any subdirectory of path
 
 **Usage Notes**:
+
 - Patterns are relative to the project root
 - Exclude patterns are processed before include patterns
 - More specific patterns take precedence over general ones
@@ -183,6 +187,7 @@ include = [
 ```
 
 **Usage Notes**:
+
 - If `include` is empty, all Markdown files are included (subject to exclude patterns)
 - When `include` is specified, only matching files are processed
 - Combine with `exclude` for fine-grained control
@@ -210,10 +215,12 @@ respect_gitignore = false  # Ignore .gitignore files
 ```
 
 **Behavior**:
+
 - `true` (default): Files and directories listed in `.gitignore` are automatically excluded
 - `false`: `.gitignore` files are ignored, all Markdown files are considered
 
 **Usage Notes**:
+
 - This setting only affects directory scanning, not explicitly provided file paths
 - Useful for linting files that are normally ignored (e.g., generated docs)
 - When disabled, you may need more specific `exclude` patterns
@@ -240,11 +247,13 @@ line_length = 120  # Set global line length to 120 characters
 ```
 
 **Behavior**:
+
 - Used as the default line length for MD013 and other line-length-related rules
 - Rule-specific configurations override the global setting
 - Useful for projects that want a consistent line length across all line-length rules
 
 **Usage Notes**:
+
 - Must be a positive integer
 - Common values: 80 (traditional), 100 (relaxed), 120 (modern)
 - Individual rules can still override this setting in their own configuration
@@ -274,12 +283,14 @@ flavor = "mkdocs"  # Use MkDocs flavor
 ```
 
 **Available Flavors**:
+
 - `"standard"` (default): Standard Markdown syntax
 - `"mkdocs"`: MkDocs-specific extensions and syntax
 
 **Note**: Additional flavors like `"gfm"` (GitHub Flavored Markdown) and `"commonmark"` are planned for future releases. Currently, specifying these will emit a warning and use standard flavor.
 
 **Behavior**:
+
 - Affects how certain rules behave, particularly:
   - MD042: Empty links handling (MkDocs allows certain shorthand links)
   - MD052: Reference-style links and images (MkDocs has special syntax)
@@ -287,6 +298,7 @@ flavor = "mkdocs"  # Use MkDocs flavor
 - Some rules may be automatically adjusted based on the flavor
 
 **Usage Notes**:
+
 - Choose the flavor that matches your documentation system
 - MkDocs flavor is useful for projects using MkDocs or Material for MkDocs
 - Currently only `standard` and `mkdocs` have implementation differences
@@ -324,6 +336,7 @@ rumdl check --disable MD001,MD013 --exclude "temp/**" docs/
 ```
 
 The final configuration will be:
+
 - `disable`: `["MD001", "MD013"]` (CLI overrides file)
 - `exclude`: `["temp/**"]` (CLI overrides file)
 - Paths: `["docs/"]` (CLI argument)
@@ -365,6 +378,7 @@ respect_gitignore = true
 ```
 
 File selection process:
+
 1. Start with: `docs/guide.md`, `docs/temp/test.md`, `README.md`, `notes.draft.md`
 2. Apply includes: `docs/guide.md`, `docs/temp/test.md`, `README.md` (notes.draft.md excluded)
 3. Apply excludes: `docs/guide.md`, `README.md` (docs/temp/test.md excluded)

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md005.md

@@ -67,6 +67,7 @@ preferred indentation pattern (2, 3, 4 spaces, etc.) and ensures consistency thr
 ## Configuration
 
 This rule has no configuration options. MD005 automatically detects and adapts to your indentation pattern:
+
 - Top-level items should always start at column 0
 - Nested items align with their parent's text content OR use the detected indent increment
 - The rule intelligently detects whether you're using 2, 3, 4, or other space increments

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md013.md

@@ -55,7 +55,8 @@ MD013:
   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)
-  enable_reflow: false          # Enable automatic text reflow/wrapping (default: false)
+  reflow: false                 # Enable automatic text reflow/wrapping (default: false)
+  reflow_mode: "default"        # Reflow mode: "default", "normalize", or "sentence_per_line" (default: "default")
 ```
 
 ### Configuration options explained
@@ -68,7 +69,8 @@ MD013:
 - `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
-- `enable_reflow`: When true, enables automatic text reflow to wrap long lines intelligently
+- `reflow`: When true, enables automatic text reflow to wrap long lines intelligently
+- `reflow_mode`: Controls how text is reflowed when `reflow` is true (see Reflow Modes section below)
 
 ### Example with different limits
 
@@ -82,6 +84,7 @@ MD013:
 ```
 
 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
@@ -100,7 +103,7 @@ def very_long_function_name_that_demonstrates_the_code_block_line_length_configu
 
 ## Automatic fixes
 
-When `enable_reflow` is set to `true`, this rule can automatically wrap long lines while preserving Markdown formatting:
+When `reflow` is set to `true`, this rule can automatically wrap long lines while preserving Markdown formatting:
 
 - Intelligently breaks lines at appropriate points
 - Preserves bold, italic, links, code spans, and other Markdown elements
@@ -108,17 +111,79 @@ When `enable_reflow` is set to `true`, this rule can automatically wrap long lin
 - Preserves hard line breaks (two trailing spaces)
 - Does not wrap code blocks, tables, headings, or reference definitions
 
+### Reflow Modes
+
+The `reflow_mode` option controls how text is reformatted when `reflow` is true:
+
+#### `default` mode
+
+Standard text wrapping that breaks lines at word boundaries to fit within the configured line length.
+
+```yaml
+MD013:
+  line_length: 80
+  reflow: true
+  reflow_mode: "default"
+```
+
+#### `normalize` mode
+
+Normalizes all paragraph text to consistently wrap at the configured line length, removing irregular line breaks.
+
+```yaml
+MD013:
+  line_length: 80
+  reflow: true
+  reflow_mode: "normalize"
+```
+
+This mode is useful for standardizing documents with inconsistent line wrapping.
+
+#### `sentence_per_line` mode
+
+Enforces one sentence per line, making diffs cleaner and easier to review. This mode:
+
+- Detects sentence boundaries (periods, exclamation marks, question marks)
+- Handles common abbreviations (Mr., Dr., etc.) without breaking
+- Preserves decimal numbers and ellipses
+- Works with markdown formatting
+
+```yaml
+MD013:
+  line_length: 80
+  reflow: true
+  reflow_mode: "sentence_per_line"
+```
+
+Example transformation:
+
+```markdown
+# Before
+This is the first sentence. This is the second sentence. And this is the third.
+
+# After
+This is the first sentence.
+This is the second sentence.
+And this is the third.
+```
+
+This mode is particularly useful for:
+
+- Technical documentation where each sentence often contains a single concept
+- Documents maintained in version control where sentence-level diffs are clearer
+- Collaborative writing where different authors work on different sentences
+
 ### Example with automatic reflow
 
 ```yaml
 MD013:
   line_length: 80
-  enable_reflow: true
+  reflow: true
 ```
 
 With this configuration, long lines will be automatically wrapped to fit within 80 characters while maintaining proper Markdown formatting.
 
-**Note**: When `enable_reflow` is `false` (default), automatic fixes are not available and you'll need to manually wrap long lines.
+**Note**: When `reflow` is `false` (default), automatic fixes are not available and you'll need to manually wrap long lines.
 
 ## Learn more
 

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md018.md

@@ -56,6 +56,7 @@ 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

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md020.md

@@ -54,6 +54,7 @@ This rule has no configuration options.
 ## Automatic fixes
 
 This rule automatically adds spaces where they're missing:
+
 - After the opening # symbols
 - Before the closing # symbols
 

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md021.md

@@ -54,6 +54,7 @@ This rule has no configuration options.
 ## Automatic fixes
 
 This rule automatically removes extra spaces:
+
 - Leaves only one space after the opening # symbols
 - Leaves only one space before the closing # symbols
 

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md022.md

@@ -76,6 +76,7 @@ MD022:
 ## Automatic fixes
 
 This rule automatically adds the required number of blank lines:
+
 - Before headings (except at the start of a document)
 - After headings (except at the end of a document)
 

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md025.md

@@ -64,6 +64,7 @@ MD025:
 ## Automatic fixes
 
 This rule will:
+
 - Convert extra main titles to the next heading level (H1 → H2)
 - Preserve the document's first main title
 - Maintain the relative hierarchy of subsequent headings

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md026.md

@@ -61,6 +61,7 @@ MD026:
 ## Automatic fixes
 
 This rule will:
+
 - Remove periods, commas, and semicolons from heading endings
 - Preserve question marks for questions ("What is Markdown?")
 - Keep exclamation points for emphasis ("Important!")

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md029.md

@@ -59,6 +59,7 @@ MD029:
 ## Automatic fixes
 
 This rule will:
+
 - Renumber all list items according to your chosen style
 - Preserve list item content and indentation
 - Handle nested lists independently

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md030.md

@@ -60,6 +60,7 @@ MD030:
 ## Automatic fixes
 
 This rule will:
+
 - Adjust spacing after list markers to match your configuration
 - Preserve list item content and structure
 - Handle single-line and multi-line items according to their specific settings

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md031.md

@@ -90,6 +90,7 @@ When `list_items` is false:
 ## Automatic fixes
 
 This rule automatically adds blank lines:
+
 - Before code blocks that don't have one
 - After code blocks that don't have one
 

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md032.md

@@ -58,6 +58,7 @@ This rule has no configuration options. Lists should always be surrounded by bla
 ## Automatic fixes
 
 This rule will:
+
 - Add a blank line before lists that follow other content
 - Add a blank line after lists that precede other content
 - Handle nested lists correctly (only the outermost list needs surrounding blank lines)

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md033.md

@@ -98,6 +98,7 @@ This rule can automatically remove HTML tags when no allowed elements are config
 ## What's allowed
 
 These are **not** considered HTML and are allowed:
+
 - HTML comments: `<!-- This is a comment -->`
 - Email autolinks: `<user@example.com>`
 - URL autolinks: `<https://example.com>`

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md037.md

@@ -66,6 +66,7 @@ This rule has no configuration options.
 ## Automatic fixes
 
 This rule will automatically remove spaces between:
+
 - Opening emphasis markers and the first character
 - Last character and closing emphasis markers
 - Preserves all other spacing in your text

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md038.md

@@ -60,6 +60,7 @@ This rule has no configuration options.
 ## Automatic fixes
 
 This rule will:
+
 - Remove spaces after opening backticks
 - Remove spaces before closing backticks
 - Preserve spaces within the code itself

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md039.md

@@ -66,6 +66,7 @@ This rule has no configuration options.
 ## Automatic fixes
 
 This rule will:
+
 - Remove spaces after opening brackets `[`
 - Remove spaces before closing brackets `]`
 - Work on both regular links and image alt text

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md041.md

@@ -75,6 +75,7 @@ MD041:
 ## Automatic fixes
 
 When enabled, this rule will:
+
 - Add a generic `# Title` heading at the beginning of documents that lack one
 - You should replace this with a meaningful title for your document
 

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md042.md

@@ -56,6 +56,7 @@ This rule has no configuration options.
 ## Automatic fixes
 
 When enabled, this rule will:
+
 - Add generic text "Link" for empty link text
 - Add placeholder "#" for empty URLs
 - Replace these placeholders with meaningful content after fixing

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md043.md

@@ -94,6 +94,7 @@ MD043:
 ## Automatic fixes
 
 When enabled, this rule will:
+
 - Replace incorrect headings with the required ones
 - Preserve heading content when using regex patterns
 - Maintain document flow and readability

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md044.md

@@ -68,6 +68,7 @@ MD044:
 ## Automatic fixes
 
 When enabled, this rule will:
+
 - Replace all incorrect capitalizations with the proper version
 - Preserve the context and meaning of your text
 - Work across headings, paragraphs, and lists

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md045.md

@@ -76,6 +76,7 @@ This would change the fix behavior to:
 ## Automatic fixes
 
 When enabled, this rule will:
+
 - Add generic "Image" text for missing alt text
 - You must replace this with meaningful descriptions
 - Consider what information the image conveys

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md046.md

@@ -86,6 +86,7 @@ MD046:
 ## Automatic fixes
 
 When enabled, this rule will:
+
 - Convert all code blocks to match your configured style
 - Preserve code content and language identifiers
 - Maintain proper spacing around blocks
@@ -93,11 +94,13 @@ When enabled, this rule will:
 ## Style comparison
 
 **Fenced code blocks** (recommended):
+
 - Support syntax highlighting with language identifiers
 - Easier to copy and paste
 - More visible boundaries
 
 **Indented code blocks**:
+
 - Traditional Markdown style
 - No language identifier support
 - Must indent each line with 4 spaces or 1 tab

{rumdl-0.0.143 → rumdl-0.0.144}/docs/md047.md

@@ -68,6 +68,7 @@ This rule has no configuration options.
 ## Automatic fixes
 
 When enabled, this rule will:
+
 - Add a newline if the file doesn't end with one
 - Remove extra newlines if there are multiple
 - Ensure exactly one newline at the end