rumdl 0.0.159__tar.gz → 0.0.160__tar.gz

{rumdl-0.0.159 → rumdl-0.0.160}/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.160] - 2025-10-15
+
+### Fixed
+
+- **Configuration**: Fixed `rumdl init --pyproject` command to no longer create `.rumdl.toml` file
+  - The command now correctly only adds rumdl configuration to `pyproject.toml`
+  - Prevents confusion from having duplicate configuration files
+
+- **MD044**: Corrected field name in templates and documentation
+  - Fixed inconsistency in proper names configuration
+  - Improved accuracy of documentation examples
+
+- **Configuration System**: Added field aliases and validation warnings for all rules
+  - Better backwards compatibility with alternative field names
+  - Helpful warnings guide users to correct configuration syntax
+  - Improved user experience when migrating configurations
+
 ## [0.0.159] - 2025-10-14
 
 ### Added

{rumdl-0.0.159 → rumdl-0.0.160}/Cargo.lock

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

{rumdl-0.0.159 → rumdl-0.0.160}/Cargo.toml

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

{rumdl-0.0.159 → rumdl-0.0.160}/PKG-INFO

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

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md007.md

@@ -57,8 +57,8 @@ 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)
-  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)
+  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
@@ -67,13 +67,13 @@ MD007:
 - `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
+### Example with start-indented: true
 
 ```yaml
 MD007:
   indent: 2
-  start_indented: true
-  start_indent: 4
+  start-indented: true
+  start-indent: 4
 ```
 
 With this configuration, the following is valid:

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md009.md

@@ -45,7 +45,7 @@ Clean and tidy now
 
 ```yaml
 MD009:
-  br_spaces: 2      # Number of spaces for hard line breaks (default: 2)
+  br-spaces: 2      # Number of spaces for hard line breaks (default: 2)
   strict: false     # Remove all trailing spaces, even line breaks (default: false)
 ```
 

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md010.md

@@ -63,7 +63,7 @@ Replaces tab characters with spaces to ensure consistent indentation across all
 
 ```yaml
 MD010:
-  spaces_per_tab: 4                     # Number of spaces to replace each tab with (default: 4)
+  spaces-per-tab: 4                     # Number of spaces to replace each tab with (default: 4)
 ```
 
 ### Configuration options explained

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md013.md

@@ -47,16 +47,16 @@ 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)
+  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)
+  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)
   reflow: false                 # Enable automatic text reflow/wrapping (default: false)
-  reflow_mode: "default"        # Reflow mode: "default", "normalize", or "sentence_per_line" (default: "default")
+  reflow-mode: "default"        # Reflow mode: "default", "normalize", or "sentence-per-line" (default: "default")
 ```
 
 ### Configuration options explained
@@ -76,10 +76,10 @@ MD013:
 
 ```yaml
 MD013:
-  line_length: 80
-  heading_line_length: 100
-  code_block_line_length: 120
-  code_blocks: true
+  line-length: 80
+  heading-line-length: 100
+  code-block-line-length: 120
+  code-blocks: true
   headings: true
 ```
 
@@ -121,9 +121,9 @@ Standard text wrapping that breaks lines at word boundaries to fit within the co
 
 ```yaml
 MD013:
-  line_length: 80
+  line-length: 80
   reflow: true
-  reflow_mode: "default"
+  reflow-mode: "default"
 ```
 
 #### `normalize` mode
@@ -132,14 +132,14 @@ Normalizes all paragraph text to consistently wrap at the configured line length
 
 ```yaml
 MD013:
-  line_length: 80
+  line-length: 80
   reflow: true
-  reflow_mode: "normalize"
+  reflow-mode: "normalize"
 ```
 
 This mode is useful for standardizing documents with inconsistent line wrapping.
 
-#### `sentence_per_line` mode
+#### `sentence-per-line` mode
 
 Enforces one sentence per line, making diffs cleaner and easier to review. This mode:
 
@@ -150,9 +150,9 @@ Enforces one sentence per line, making diffs cleaner and easier to review. This
 
 ```yaml
 MD013:
-  line_length: 80
+  line-length: 80
   reflow: true
-  reflow_mode: "sentence_per_line"
+  reflow-mode: "sentence-per-line"
 ```
 
 Example transformation:
@@ -177,7 +177,7 @@ This mode is particularly useful for:
 
 ```yaml
 MD013:
-  line_length: 80
+  line-length: 80
   reflow: true
 ```
 

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md022.md

@@ -69,8 +69,8 @@ And even more content.
 
 ```yaml
 MD022:
-  lines_above: 1    # Blank lines required above headings (default: 1)
-  lines_below: 1    # Blank lines required below headings (default: 1)
+  lines-above: 1    # Blank lines required above headings (default: 1)
+  lines-below: 1    # Blank lines required below headings (default: 1)
 ```
 
 ## Automatic fixes

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md024.md

@@ -75,8 +75,8 @@ How to run the test suite...
 
 ```yaml
 MD024:
-  allow_different_nesting: false  # Allow duplicates at different levels (default: false)
-  siblings_only: false           # Only check siblings at same level (default: false)
+  allow-different-nesting: false  # Allow duplicates at different levels (default: false)
+  siblings-only: false           # Only check siblings at same level (default: false)
 ```
 
 ## Automatic fixes

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md025.md

@@ -58,7 +58,7 @@ More content here.
 ```yaml
 MD025:
   level: 1                    # The heading level that should be unique (default: 1)
-  front_matter_title: "title" # Name of the front matter title field (default: "title")
+  front-matter-title: "title" # Name of the front matter title field (default: "title")
 ```
 
 ## Automatic fixes

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md030.md

@@ -51,10 +51,10 @@ Ensures consistent spacing between list markers (bullets or numbers) and the tex
 
 ```yaml
 MD030:
-  ul_single: 1  # Spaces after bullet for single-line items (default: 1)
-  ol_single: 1  # Spaces after number for single-line items (default: 1)
-  ul_multi: 1   # Spaces after bullet for multi-line items (default: 1)
-  ol_multi: 1   # Spaces after number for multi-line items (default: 1)
+  ul-single: 1  # Spaces after bullet for single-line items (default: 1)
+  ol-single: 1  # Spaces after number for single-line items (default: 1)
+  ul-multi: 1   # Spaces after bullet for multi-line items (default: 1)
+  ol-multi: 1   # Spaces after number for multi-line items (default: 1)
 ```
 
 ## Automatic fixes

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md031.md

@@ -57,7 +57,7 @@ And here's more text after the code.
 
 ```yaml
 MD031:
-  list_items: true  # Also require blank lines in lists (default: true)
+  list-items: true  # Also require blank lines in lists (default: true)
 ```
 
 ### Example with list_items

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md033.md

@@ -77,14 +77,14 @@ This is a paragraph with **bold** and *italic* text.
 
 ```yaml
 MD033:
-  allowed_elements: []  # List of allowed HTML tags (default: none)
+  allowed-elements: []  # List of allowed HTML tags (default: none)
 ```
 
 ### Example allowing specific tags
 
 ```yaml
 MD033:
-  allowed_elements: ["br", "hr", "details", "summary"]
+  allowed-elements: ["br", "hr", "details", "summary"]
 ```
 
 This would allow line breaks, horizontal rules, and collapsible sections while blocking other HTML.

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md041.md

@@ -68,8 +68,8 @@ First, install the dependencies...
 ```yaml
 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
+  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

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md043.md

@@ -88,7 +88,7 @@ MD043:
     - "## Installation"
     - "## Usage"
     - "/## .*License/"       # Regex patterns supported
-  match_case: false          # Case-sensitive matching (default: false)
+  match-case: false          # Case-sensitive matching (default: false)
 ```
 
 ## Automatic fixes

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md044.md

@@ -60,9 +60,9 @@ MD044:
     - "GitHub"  
     - "Node.js"
     - "npm"                  # Yes, npm is lowercase!
-  code_blocks: false         # Check inside code blocks (default: true)
-  html_elements: true        # Check inside HTML elements (default: true)
-  html_comments: true        # Check inside HTML comments (default: true)
+  code-blocks: false         # Check inside code blocks (default: true)
+  html-elements: true        # Check inside HTML elements (default: true)
+  html-comments: true        # Check inside HTML comments (default: true)
 ```
 
 ## Automatic fixes

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md045.md

@@ -53,7 +53,7 @@ Ensures all images include alternative text (alt text) that describes the image
 
 ```yaml
 MD045:
-  placeholder_text: "TODO: Add image description"  # Text to insert for missing alt text
+  placeholder-text: "TODO: Add image description"  # Text to insert for missing alt text
 ```
 
 ### Options
@@ -64,7 +64,7 @@ MD045:
 
 ```yaml
 MD045:
-  placeholder_text: "FIXME: Add alt text"
+  placeholder-text: "FIXME: Add alt text"
 ```
 
 This would change the fix behavior to:

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md053.md

@@ -52,14 +52,14 @@ Check out [our website](https://example.com) directly.
 
 ```yaml
 MD053:
-  ignored_definitions: []  # List of reference names to keep even if unused
+  ignored-definitions: []  # List of reference names to keep even if unused
 ```
 
 ### Example with ignored definitions
 
 ```yaml
 MD053:
-  ignored_definitions: ["todo", "draft", "template"]
+  ignored-definitions: ["todo", "draft", "template"]
 ```
 
 This keeps reference definitions with names like "todo", "draft", or "template" even if they're not currently used.

{rumdl-0.0.159 → rumdl-0.0.160}/docs/md058.md

@@ -54,16 +54,16 @@ As you can see, we have a diverse team.
 
 ```yaml
 MD058:
-  minimum_before: 1  # Blank lines before table
-  minimum_after: 1   # Blank lines after table
+  minimum-before: 1  # Blank lines before table
+  minimum-after: 1   # Blank lines after table
 ```
 
 ### Examples with different settings
 
 ```yaml
 MD058:
-  minimum_before: 2  # Require 2 blank lines before
-  minimum_after: 1   # Require 1 blank line after
+  minimum-before: 2  # Require 2 blank lines before
+  minimum-after: 1   # Require 1 blank line after
 ```
 
 ## Automatic fixes

{rumdl-0.0.159 → rumdl-0.0.160}/rumdl.toml.example

@@ -61,4 +61,4 @@ headings = true  # Exclude headings from line length check
 
 [MD044]
 names = ["rumdl", "Markdown", "GitHub"]  # Proper names that should be capitalized correctly
-code_blocks_excluded = true  # Exclude code blocks from proper name check
+code-blocks = true  # Exclude code blocks from proper name check

{rumdl-0.0.159 → rumdl-0.0.160}/src/config.rs

@@ -365,7 +365,7 @@ respect_gitignore = true
 
 # [MD044]
 # names = ["rumdl", "Markdown", "GitHub"]  # Proper names that should be capitalized correctly
-# code_blocks_excluded = true  # Exclude code blocks from proper name check
+# code-blocks = true  # Exclude code blocks from proper name check
 "#;
 
     // Write the default configuration to the file
@@ -459,7 +459,7 @@ respect-gitignore = true
 
 # [tool.rumdl.MD044]
 # names = ["rumdl", "Markdown", "GitHub"]  # Proper names that should be capitalized correctly
-# code_blocks_excluded = true  # Exclude code blocks from proper name check
+# code-blocks = true  # Exclude code blocks from proper name check
 "#;
 
     config_content.to_string()

{rumdl-0.0.159 → rumdl-0.0.160}/src/main.rs

@@ -582,8 +582,8 @@ fn main() -> Result<(), Box<dyn Error>> {
                     } else {
                         // Create new pyproject.toml with basic structure
                         let basic_content = r#"[build-system]
-requires = [\"setuptools>=42\", \"wheel\"]
-build-backend = \"setuptools.build_meta\"
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
 
 "#;
                         let content = basic_content.to_owned() + &config_content;
@@ -598,19 +598,19 @@ build-backend = \"setuptools.build_meta\"
                             }
                         }
                     }
-                }
-
-                // Create default config file
-                match rumdl_config::create_default_config(".rumdl.toml") {
-                    Ok(_) => {
-                        println!("Created default configuration file: .rumdl.toml");
+                } else {
+                    // Create default .rumdl.toml config file
+                    match rumdl_config::create_default_config(".rumdl.toml") {
+                        Ok(_) => {
+                            println!("Created default configuration file: .rumdl.toml");
 
-                        // Offer to install VS Code extension
-                        offer_vscode_extension_install();
-                    }
-                    Err(e) => {
-                        eprintln!("{}: Failed to create config file: {}", "Error".red().bold(), e);
-                        exit::tool_error();
+                            // Offer to install VS Code extension
+                            offer_vscode_extension_install();
+                        }
+                        Err(e) => {
+                            eprintln!("{}: Failed to create config file: {}", "Error".red().bold(), e);
+                            exit::tool_error();
+                        }
                     }
                 }
             }

{rumdl-0.0.159 → rumdl-0.0.160}/src/rule_config_serde.rs

@@ -12,6 +12,9 @@ pub trait RuleConfig: Serialize + DeserializeOwned + Default + Clone {
 }
 
 /// Helper to load rule configuration from the global config
+///
+/// This function will emit warnings to stderr if the configuration is invalid,
+/// helping users identify and fix configuration errors.
 pub fn load_rule_config<T: RuleConfig>(config: &crate::config::Config) -> T {
     config
         .rules
@@ -28,7 +31,17 @@ pub fn load_rule_config<T: RuleConfig>(config: &crate::config::Config) -> T {
             let toml_table = toml::Value::Table(table);
 
             // Deserialize directly from TOML, which preserves serde attributes
-            toml_table.try_into().ok()
+            match toml_table.try_into::<T>() {
+                Ok(config) => Some(config),
+                Err(e) => {
+                    // Emit a warning about the invalid configuration
+                    eprintln!("Warning: Invalid configuration for rule {}: {}", T::RULE_NAME, e);
+                    eprintln!("Using default values for rule {}.", T::RULE_NAME);
+                    eprintln!("Hint: Check the documentation for valid configuration values.");
+
+                    None
+                }
+            }
         })
         .unwrap_or_default()
 }
@@ -353,4 +366,40 @@ mod tests {
         let json_float = toml_value_to_json(&valid_float).unwrap();
         assert_eq!(json_float, serde_json::json!(1.23));
     }
+
+    #[test]
+    fn test_invalid_config_returns_default() {
+        // Create config with unknown field
+        let mut config = crate::config::Config::default();
+        let mut rule_values = BTreeMap::new();
+        rule_values.insert("unknown_field".to_string(), toml::Value::Boolean(true));
+        // Use a table value for items, which expects an array
+        rule_values.insert("items".to_string(), toml::Value::Table(toml::map::Map::new()));
+
+        config
+            .rules
+            .insert("TEST001".to_string(), crate::config::RuleConfig { values: rule_values });
+
+        // Load config - should return default and print warning
+        let rule_config: TestRuleConfig = load_rule_config(&config);
+        // Should use default values since deserialization failed
+        assert_eq!(rule_config, TestRuleConfig::default());
+    }
+
+    #[test]
+    fn test_invalid_field_type() {
+        // Create config with wrong type for field
+        let mut config = crate::config::Config::default();
+        let mut rule_values = BTreeMap::new();
+        // indent should be i64, but we're providing a string
+        rule_values.insert("indent".to_string(), toml::Value::String("not_a_number".to_string()));
+
+        config
+            .rules
+            .insert("TEST001".to_string(), crate::config::RuleConfig { values: rule_values });
+
+        // Load config - should return default and print warning
+        let rule_config: TestRuleConfig = load_rule_config(&config);
+        assert_eq!(rule_config, TestRuleConfig::default());
+    }
 }

{rumdl-0.0.159 → rumdl-0.0.160}/src/rules/md007_ul_indent/md007_config.rs

@@ -23,11 +23,11 @@ pub struct MD007Config {
     pub indent: usize,
 
     /// Allow first level lists to start indented (default: false)
-    #[serde(default)]
+    #[serde(default, alias = "start_indented")]
     pub start_indented: bool,
 
     /// Number of spaces for first level indent when start_indented is true (default: 2)
-    #[serde(default = "default_start_indent")]
+    #[serde(default = "default_start_indent", alias = "start_indent")]
     pub start_indent: usize,
 
     /// Indentation style: text-aligned (default) or fixed (markdownlint compatible)
@@ -57,3 +57,32 @@ impl Default for MD007Config {
 impl RuleConfig for MD007Config {
     const RULE_NAME: &'static str = "MD007";
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_snake_case_backwards_compatibility() {
+        // Test that snake_case field names work for backwards compatibility
+        let toml_str = r#"
+            start_indented = true
+            start_indent = 4
+        "#;
+        let config: MD007Config = toml::from_str(toml_str).unwrap();
+        assert!(config.start_indented);
+        assert_eq!(config.start_indent, 4);
+    }
+
+    #[test]
+    fn test_kebab_case_canonical_format() {
+        // Test that kebab-case (canonical format) works
+        let toml_str = r#"
+            start-indented = true
+            start-indent = 4
+        "#;
+        let config: MD007Config = toml::from_str(toml_str).unwrap();
+        assert!(config.start_indented);
+        assert_eq!(config.start_indent, 4);
+    }
+}

{rumdl-0.0.159 → rumdl-0.0.160}/src/rules/md009_trailing_spaces/md009_config.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
 #[serde(rename_all = "kebab-case")]
 pub struct MD009Config {
     /// Number of spaces for line breaks (default: 2)
-    #[serde(default = "default_br_spaces")]
+    #[serde(default = "default_br_spaces", alias = "br_spaces")]
     pub br_spaces: usize,
 
     /// Strict mode - remove all trailing spaces (default: false)
@@ -14,7 +14,7 @@ pub struct MD009Config {
     pub strict: bool,
 
     /// Allow trailing spaces in empty list item lines (default: false)
-    #[serde(default)]
+    #[serde(default, alias = "list_item_empty_lines")]
     pub list_item_empty_lines: bool,
 }
 
@@ -35,3 +35,30 @@ impl Default for MD009Config {
 impl RuleConfig for MD009Config {
     const RULE_NAME: &'static str = "MD009";
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_snake_case_backwards_compatibility() {
+        let toml_str = r#"
+            br_spaces = 3
+            list_item_empty_lines = true
+        "#;
+        let config: MD009Config = toml::from_str(toml_str).unwrap();
+        assert_eq!(config.br_spaces, 3);
+        assert!(config.list_item_empty_lines);
+    }
+
+    #[test]
+    fn test_kebab_case_canonical_format() {
+        let toml_str = r#"
+            br-spaces = 3
+            list-item-empty-lines = true
+        "#;
+        let config: MD009Config = toml::from_str(toml_str).unwrap();
+        assert_eq!(config.br_spaces, 3);
+        assert!(config.list_item_empty_lines);
+    }
+}

{rumdl-0.0.159 → rumdl-0.0.160}/src/rules/md010_no_hard_tabs/md010_config.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
 #[serde(rename_all = "kebab-case")]
 pub struct MD010Config {
     /// Number of spaces per tab (default: 4)
-    #[serde(default = "default_spaces_per_tab")]
+    #[serde(default = "default_spaces_per_tab", alias = "spaces_per_tab")]
     pub spaces_per_tab: usize,
 }