rumdl 0.0.81__tar.gz → 0.0.82__tar.gz

{rumdl-0.0.81 → rumdl-0.0.82}/Cargo.lock

@@ -1783,7 +1783,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.81"
+version = "0.0.82"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.81 → rumdl-0.0.82}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.81"
+version = "0.0.82"
 edition = "2021"
 description = "A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)"
 authors = ["Ruben J. Jongejan <ruben.jongejan@gmail.com>"]

{rumdl-0.0.81 → rumdl-0.0.82}/PKG-INFO

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

{rumdl-0.0.81 → rumdl-0.0.82}/docs/global-settings.md

@@ -87,6 +87,7 @@ enable = ["MD001", "MD003", "MD013", "MD022"]
 - Useful for gradually adopting rumdl or focusing on specific rule categories
 
 **Example CLI usage**:
+
 ```bash
 rumdl check --enable MD001,MD003,MD013 .
 ```
@@ -113,6 +114,7 @@ disable = ["MD013", "MD033", "MD041"]
 - Can be combined with rule-specific configuration to fine-tune behavior
 
 **Example CLI usage**:
+
 ```bash
 rumdl check --disable MD013,MD033 .
 ```
@@ -150,6 +152,7 @@ exclude = [
 - Useful for excluding generated files, dependencies, and temporary files
 
 **Example CLI usage**:
+
 ```bash
 rumdl check --exclude "node_modules,build,*.tmp.md" .
 ```
@@ -180,6 +183,7 @@ include = [
 - Useful for limiting linting to specific documentation areas
 
 **Example CLI usage**:
+
 ```bash
 rumdl check --include "docs/**/*.md,README.md" .
 ```
@@ -210,6 +214,7 @@ respect_gitignore = false  # Ignore .gitignore files
 - Respects `.gitignore` files at any level in the directory tree
 
 **Example CLI usage**:
+
 ```bash
 # Don't respect .gitignore files
 rumdl check --respect-gitignore=false .
@@ -240,6 +245,7 @@ line_length = 120  # Set global line length to 120 characters
 - When importing from markdownlint configs, top-level `line-length` is mapped to this setting
 
 **Example with rule override**:
+
 ```toml
 [global]
 line_length = 100  # Global default
@@ -259,6 +265,7 @@ Settings are applied in the following order (later sources override earlier ones
 ### Example: Precedence in Action
 
 Given this configuration file:
+
 ```toml
 [global]
 disable = ["MD013", "MD033"]
@@ -266,6 +273,7 @@ exclude = ["node_modules", "build"]
 ```
 
 And this command:
+
 ```bash
 rumdl check --disable MD001,MD013 --exclude "temp/**" docs/
 ```
@@ -280,24 +288,30 @@ The final configuration will be:
 rumdl processes files using the following logic:
 
 1. **Start with candidate files**:
-   - If paths are provided via CLI: use those files/directories
-   - Otherwise: recursively scan current directory for `.md` and `.markdown` files
+
+- If paths are provided via CLI: use those files/directories
+- Otherwise: recursively scan current directory for `.md` and `.markdown` files
 
 2. **Apply .gitignore filtering** (if `respect_gitignore = true`):
-   - Skip files/directories listed in `.gitignore` files
+
+- Skip files/directories listed in `.gitignore` files
 
 3. **Apply include patterns** (if specified):
-   - Keep only files matching at least one include pattern
+
+- Keep only files matching at least one include pattern
 
 4. **Apply exclude patterns**:
-   - Remove files matching any exclude pattern
+
+- Remove files matching any exclude pattern
 
 5. **Apply rule filtering**:
-   - Process remaining files with enabled rules only
+
+- Process remaining files with enabled rules only
 
 ### Example: File Selection
 
 Given this configuration:
+
 ```toml
 [global]
 include = ["docs/**/*.md", "README.md"]
@@ -488,4 +502,4 @@ find . -name "*.md" -o -name "*.markdown" | head -10
 - [Configuration Guide](../README.md#configuration) - Basic configuration setup
 - [Rules Reference](RULES.md) - Complete list of available rules
 - [CLI Reference](../README.md#command-line-interface) - Command-line options
-- [Rule-specific Configuration](../README.md#configuration-file-example) - Configuring individual rules
+- [Rule-specific Configuration](../README.md#configuration-file-example) - Configuring individual rules

rumdl-0.0.82/docs/md001.md

@@ -0,0 +1,60 @@
+# MD001 - Heading levels should only increment by one
+
+## What this rule does
+
+Prevents skipping heading levels (like jumping from # to ### without ##).
+
+## Why this matters
+
+- **Document structure**: Logical heading hierarchy makes documents easier to navigate
+- **Accessibility**: Screen readers rely on proper heading order to help users
+- **Table of contents**: Automated TOC generators need correct heading levels
+- **SEO**: Search engines use heading structure to understand content
+
+## Examples
+
+### ✅ Correct
+
+```markdown
+# Title
+## Chapter 1
+### Section 1.1
+### Section 1.2
+## Chapter 2
+### Section 2.1
+```
+
+### ❌ Incorrect
+
+```markdown
+# Title
+### Section 1.1     (skipped level 2)
+##### Subsection    (skipped levels 2, 3, and 4)
+```
+
+### 🔧 Fixed
+
+```markdown
+# Title
+## Section 1.1
+### Subsection
+```
+
+## Configuration
+
+This rule has no configuration options.
+
+## Automatic fixes
+
+This rule automatically adjusts heading levels to maintain proper hierarchy, changing skipped levels to the next appropriate level.
+
+## Learn more
+
+- [Web Content Accessibility Guidelines - Headings](https://www.w3.org/WAI/tutorials/page-structure/headings/) - Why heading structure matters
+- [CommonMark headings](https://spec.commonmark.org/0.31.2/#atx-headings) - Technical specification
+
+## Related rules
+
+- [MD002](md002.md) - First heading should be a top-level heading
+- [MD003](md003.md) - Heading style should be consistent
+- [MD022](md022.md) - Headings should be surrounded by blank lines

rumdl-0.0.82/docs/md002.md

@@ -0,0 +1,68 @@
+# MD002 - First heading should be a top-level heading
+
+## What this rule does
+
+Ensures the first heading in your document is a level 1 heading (# Title).
+
+## Why this matters
+
+- **Document structure**: Every document needs a clear main title
+- **Accessibility**: Screen readers expect documents to start with a main heading
+- **Navigation**: Table of contents generators need a top-level heading
+- **SEO**: Search engines look for a main H1 heading
+
+## Examples
+
+### ✅ Correct
+
+```markdown
+# Document Title
+
+## Section 1
+
+### Subsection 1.1
+
+## Section 2
+```
+
+### ❌ Incorrect
+
+```markdown
+## Document Title     (starts with level 2)
+
+### Section 1
+
+# Main Heading       (H1 appears later)
+```
+
+### 🔧 Fixed
+
+```markdown
+# Document Title
+
+## Section 1
+
+### Subsection 1.1
+```
+
+## Configuration
+
+```yaml
+MD002:
+  level: 1  # The level the first heading should be (default: 1)
+```
+
+## Automatic fixes
+
+This rule automatically changes the first heading to the configured level (default: H1).
+
+## Learn more
+
+- [Web Content Accessibility Guidelines - Page Title](https://www.w3.org/WAI/WCAG21/Understanding/page-titled.html) - Why documents need titles
+- [CommonMark headings](https://spec.commonmark.org/0.31.2/#atx-headings) - Technical specification
+
+## Related rules
+
+- [MD001](md001.md) - Heading levels should only increment by one
+- [MD003](md003.md) - Heading style should be consistent
+- [MD025](md025.md) - Only one top-level heading allowed

rumdl-0.0.82/docs/md003.md

@@ -0,0 +1,85 @@
+# MD003 - Heading style should be consistent
+
+## What this rule does
+
+Ensures all headings in your document use the same formatting style.
+
+## Why this matters
+
+- **Readability**: Consistent heading styles make documents easier to scan and navigate
+- **Professionalism**: Mixed heading styles look unprofessional and unpolished
+- **Tool compatibility**: Some tools expect consistent heading formats for navigation features
+
+## Examples
+
+### ✅ Correct (using # style)
+
+```markdown
+# First Level Heading
+## Second Level Heading
+### Third Level Heading
+```
+
+### ✅ Correct (using underline style)
+
+```markdown
+First Level Heading
+==================
+
+Second Level Heading
+------------------
+```
+
+### ❌ Incorrect (mixed styles)
+
+<!-- rumdl-disable MD003 -->
+
+```markdown
+# First Level Heading
+
+Second Level Heading
+------------------
+
+### Third Level Heading
+```
+
+<!-- rumdl-enable MD003 -->
+
+### 🔧 Fixed
+
+```markdown
+# First Level Heading
+## Second Level Heading
+### Third Level Heading
+```
+
+## Configuration
+
+```yaml
+MD003:
+  style: "consistent"  # Options: "consistent", "atx", "atx_closed", "setext"
+```
+
+### Style options explained
+
+- `"consistent"` (default): Use whatever style appears first in your document
+- `"atx"`: Use # symbols (`# Heading`)
+- `"atx_closed"`: Use # symbols at both ends (`# Heading #`)
+- `"setext"`: Use underlines (equals for level 1, dashes for level 2)
+
+> **Note**: Underline style only works for level 1 and 2 headings. Level 3 and below must use # symbols.
+
+## Automatic fixes
+
+This rule can automatically convert all headings to match your configured style or the first style found in the document.
+
+## Learn more
+
+- [CommonMark specification for headings](https://spec.commonmark.org/0.31.2/#atx-headings) - Technical details about heading syntax
+- [Setext headings](https://spec.commonmark.org/0.31.2/#setext-headings) - Details about underline-style headings
+
+## Related rules
+
+- [MD001](md001.md) - Heading levels should only increment by one
+- [MD022](md022.md) - Headings should be surrounded by blank lines
+- [MD023](md023.md) - Headings must start at the beginning of the line

rumdl-0.0.82/docs/md004.md

@@ -0,0 +1,84 @@
+# MD004 - Unordered list style should be consistent
+
+## What this rule does
+
+Ensures all unordered lists use the same marker (* or + or -) throughout your document.
+
+## Why this matters
+
+- **Visual consistency**: Mixed list markers look unprofessional and disorganized
+- **Readability**: Consistent markers make it easier to scan lists
+- **Maintenance**: One style is easier to remember and apply
+- **Style guides**: Most organizations standardize on one list marker
+
+## Examples
+
+### ✅ Correct (using * throughout)
+
+```markdown
+* Item 1
+* Item 2
+  * Nested item 1
+  * Nested item 2
+* Item 3
+```
+
+### ✅ Correct (using - throughout)
+
+```markdown
+- Item 1
+- Item 2
+  - Nested item 1
+  - Nested item 2
+- Item 3
+```
+
+### ❌ Incorrect
+
+```markdown
+* Item 1
++ Item 2  (different marker)
+  - Nested item 1
+  * Nested item 2
+- Item 3  (yet another marker)
+```
+
+### 🔧 Fixed
+
+```markdown
+* Item 1
+* Item 2
+  * Nested item 1
+  * Nested item 2
+* Item 3
+```
+
+## Configuration
+
+```yaml
+MD004:
+  style: "consistent"  # Options: "consistent", "asterisk", "plus", "dash"
+```
+
+### Style options
+
+- `"consistent"` (default): Use whatever marker appears first in your document
+- `"asterisk"`: Always use * markers
+- `"plus"`: Always use + markers  
+- `"dash"`: Always use - markers
+
+## Automatic fixes
+
+This rule automatically converts all list markers to match your configured style or the first marker found.
+
+## Learn more
+
+- [CommonMark lists](https://spec.commonmark.org/0.31.2/#lists) - Technical specification
+- [Markdown Guide - Lists](https://www.markdownguide.org/basic-syntax/#lists) - List best practices
+
+## Related rules
+
+- [MD005](md005.md) - List indentation
+- [MD007](md007.md) - Unordered list indentation  
+- [MD030](md030.md) - List marker spacing
+- [MD032](md032.md) - Lists should be surrounded by blank lines

rumdl-0.0.82/docs/md005.md

@@ -0,0 +1,79 @@
+# MD005 - List indentation should be consistent
+
+## What this rule does
+
+Ensures all list items at the same level use the same indentation (0 spaces for top level, 2 spaces per nested level).
+
+## Why this matters
+
+- **Visual alignment**: Consistent indentation makes lists easier to scan
+- **Readability**: Clear hierarchy helps readers understand list structure
+- **Rendering**: Some Markdown processors require specific indentation
+- **Maintenance**: Consistent spacing is easier to edit and update
+
+## Examples
+
+### ✅ Correct
+
+```markdown
+* Item 1
+* Item 2
+  * Nested item (2 spaces)
+  * Another nested item
+    * Deep nested (4 spaces)
+* Item 3
+
+1. First item
+2. Second item
+   1. Nested ordered (2 spaces)
+   2. Another nested
+3. Third item
+```
+
+### ❌ Incorrect
+
+```markdown
+* Item 1
+ * Item 2 (wrong: 1 space)
+   * Nested (wrong: 3 spaces)
+    * Another (wrong: 4 spaces for level 2)
+
+1. First item
+ 2. Second item (wrong: 1 space)
+    1. Nested (wrong: 4 spaces)
+
+```
+
+### 🔧 Fixed
+
+```markdown
+* Item 1
+* Item 2
+  * Nested
+  * Another
+
+1. First item
+2. Second item
+   1. Nested
+```
+
+## Configuration
+
+This rule has no configuration options. It enforces:
+- 0 spaces for top-level items
+- 2 spaces per nested level
+
+## Automatic fixes
+
+This rule automatically adjusts list item indentation to the correct number of spaces for each level.
+
+## Learn more
+
+- [CommonMark lists](https://spec.commonmark.org/0.31.2/#lists) - Technical specification
+- [Markdown Guide - Lists](https://www.markdownguide.org/basic-syntax/#lists) - List formatting guide
+
+## Related rules
+
+- [MD004](md004.md) - Unordered list style should be consistent
+- [MD007](md007.md) - Unordered list indentation
+- [MD030](md030.md) - Spaces after list markers

rumdl-0.0.82/docs/md006.md

@@ -0,0 +1,72 @@
+# MD006 - Consider starting lists at the beginning of the line
+
+## What this rule does
+
+Ensures top-level list items start at the beginning of the line (no indentation).
+
+## Why this matters
+
+- **Clarity**: Indented top-level lists can be confused with nested lists
+- **Consistency**: All documents should start lists the same way
+- **Readability**: Clear distinction between top-level and nested items
+- **Standards**: Most Markdown style guides require lists to start at column 0
+
+## Examples
+
+### ✅ Correct
+
+```markdown
+* Item 1
+* Item 2
+  * Nested item
+  * Another nested item
+* Item 3
+
+- First item
+- Second item
+  - Nested under second
+- Third item
+```
+
+### ❌ Incorrect
+
+```markdown
+  * Item 1      (indented 2 spaces)
+  * Item 2      (indented 2 spaces)
+    * Nested item
+  * Item 3      (indented 2 spaces)
+```
+
+### 🔧 Fixed
+
+```markdown
+* Item 1
+* Item 2
+  * Nested item
+* Item 3
+```
+
+## Configuration
+
+This rule has no configuration options. Top-level lists must start at the beginning of the line.
+
+## Automatic fixes
+
+This rule automatically removes indentation from top-level list items.
+
+## Special notes
+
+- Only applies to unordered lists (*, -, +)
+- Ordered lists (1., 2., etc.) are not affected
+- Each list in a document is evaluated separately
+
+## Learn more
+
+- [CommonMark lists](https://spec.commonmark.org/0.31.2/#lists) - Technical specification
+- [Markdown Guide - Lists](https://www.markdownguide.org/basic-syntax/#lists) - List best practices
+
+## Related rules
+
+- [MD004](md004.md) - Unordered list style should be consistent
+- [MD005](md005.md) - List indentation should be consistent
+- [MD007](md007.md) - Unordered list indentation

rumdl-0.0.82/docs/md007.md

@@ -0,0 +1,75 @@
+# MD007 - Keep list indentation consistent
+
+## What this rule does
+
+Ensures nested list items are indented with exactly 2 spaces per level for consistent formatting.
+
+## Why this matters
+
+- **Readability**: Consistent indentation makes nested lists easy to scan and understand
+- **Professional appearance**: Well-formatted lists look polished and organized
+- **Tool compatibility**: Many Markdown tools expect 2-space indentation for proper rendering
+- **Team consistency**: Standard indentation prevents formatting conflicts in shared documents
+
+## Examples
+
+### ✅ Correct
+
+```markdown
+* Chapter 1
+  * Section 1.1
+    * Subsection 1.1.1
+    * Subsection 1.1.2
+  * Section 1.2
+* Chapter 2
+  * Section 2.1
+```
+
+### ❌ Incorrect
+
+<!-- rumdl-disable MD007 -->
+
+```markdown
+* Chapter 1
+   * Section 1.1 (3 spaces - too many!)
+      * Subsection 1.1.1 (6 spaces)
+ * Section 1.2 (1 space - too few!)
+* Chapter 2
+    * Section 2.1 (4 spaces - inconsistent)
+
+```
+
+<!-- rumdl-enable MD007 -->
+
+### 🔧 Fixed
+
+```markdown
+* Chapter 1
+  * Section 1.1
+    * Subsection 1.1.1
+  * Section 1.2
+* Chapter 2
+  * Section 2.1
+```
+
+## Configuration
+
+```yaml
+MD007:
+  indent: 2  # Number of spaces per indentation level (default: 2)
+```
+
+## Automatic fixes
+
+This rule automatically adjusts the indentation of nested list items to use exactly 2 spaces (or your configured value) per nesting level.
+
+## Learn more
+
+- [Lists in Markdown](https://www.markdownguide.org/basic-syntax/#lists-1) - How to create well-formatted lists
+- [CommonMark specification](https://spec.commonmark.org/0.31.2/#list-items) - Technical details about list formatting
+
+## Related rules
+
+- [MD004](md004.md) - Use consistent markers for unordered lists
+- [MD005](md005.md) - Keep list indentation consistent
+- [MD006](md006.md) - Start lists at the beginning of the line