rumdl 0.0.45__tar.gz → 0.0.47__tar.gz

{rumdl-0.0.45 → rumdl-0.0.47}/Cargo.lock

@@ -1208,7 +1208,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.45"
+version = "0.0.47"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.45 → rumdl-0.0.47}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.45"
+version = "0.0.47"
 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.45 → rumdl-0.0.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.45
+Version: 0.0.47
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -59,6 +59,7 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
     - [Using pip (Python)](#using-pip-python)
     - [Download binary](#download-binary)
   - [Usage](#usage)
+  - [Pre-commit Integration](#pre-commit-integration)
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
@@ -74,7 +75,6 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
     - [Prerequisites](#prerequisites)
     - [Building](#building)
     - [Testing](#testing)
-  - [Using rumdl with pre-commit](#using-rumdl-with-pre-commit)
   - [License](#license)
 
 ## Quick Start
@@ -177,6 +177,33 @@ rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
 rumdl check --no-respect-gitignore .
 ```
 
+## Pre-commit Integration
+
+You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
+
+The recommended way is to use the official pre-commit hook repository:
+
+[rumdl-pre-commit repository](https://github.com/rvben/rumdl-pre-commit)
+
+Add the following to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/rvben/rumdl-pre-commit
+    rev: v0.0.45  # Use the latest release tag
+    hooks:
+      - id: rumdl
+        # To only check (default):
+        # args: []
+        # To automatically fix issues:
+        # args: [--fix]
+```
+
+- By default, the hook will only check for issues.
+- To automatically fix issues, add `args: [--fix]` to the hook configuration.
+
+When you run `pre-commit install` or `pre-commit run`, pre-commit will automatically install `rumdl` in an isolated Python environment using pip. You do **not** need to install rumdl manually.
+
 ## Rules
 
 rumdl implements over 50 lint rules for Markdown files. Here are some key rule categories:
@@ -391,26 +418,6 @@ make build
 make test
 ```
 
-## Using rumdl with pre-commit
-
-You can use `rumdl` as a pre-commit hook in your own projects to check your Markdown files.
-
-Add the following to your `.pre-commit-config.yaml`:
-
-```yaml
-repos:
--   repo: https://github.com/rvben/rumdl
-    rev: v0.0.45  # Use the latest release tag
-    hooks:
-    -   id: rumdl-check  # Just check for issues
-    # Or use rumdl-fix to automatically fix issues:
-    # -   id: rumdl-fix
-```
-
-Then run `pre-commit install`.
-
-Pre-commit will automatically download and install `rumdl` using `cargo`. `rumdl` will respect any `.rumdl.toml` or `pyproject.toml` configuration file present in your repository.
-
 ## License
 
 rumdl is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

{rumdl-0.0.45 → rumdl-0.0.47}/README.md

@@ -29,6 +29,7 @@
     - [Using pip (Python)](#using-pip-python)
     - [Download binary](#download-binary)
   - [Usage](#usage)
+  - [Pre-commit Integration](#pre-commit-integration)
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
@@ -44,7 +45,6 @@
     - [Prerequisites](#prerequisites)
     - [Building](#building)
     - [Testing](#testing)
-  - [Using rumdl with pre-commit](#using-rumdl-with-pre-commit)
   - [License](#license)
 
 ## Quick Start
@@ -147,6 +147,33 @@ rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
 rumdl check --no-respect-gitignore .
 ```
 
+## Pre-commit Integration
+
+You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
+
+The recommended way is to use the official pre-commit hook repository:
+
+[rumdl-pre-commit repository](https://github.com/rvben/rumdl-pre-commit)
+
+Add the following to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/rvben/rumdl-pre-commit
+    rev: v0.0.45  # Use the latest release tag
+    hooks:
+      - id: rumdl
+        # To only check (default):
+        # args: []
+        # To automatically fix issues:
+        # args: [--fix]
+```
+
+- By default, the hook will only check for issues.
+- To automatically fix issues, add `args: [--fix]` to the hook configuration.
+
+When you run `pre-commit install` or `pre-commit run`, pre-commit will automatically install `rumdl` in an isolated Python environment using pip. You do **not** need to install rumdl manually.
+
 ## Rules
 
 rumdl implements over 50 lint rules for Markdown files. Here are some key rule categories:
@@ -361,26 +388,6 @@ make build
 make test
 ```
 
-## Using rumdl with pre-commit
-
-You can use `rumdl` as a pre-commit hook in your own projects to check your Markdown files.
-
-Add the following to your `.pre-commit-config.yaml`:
-
-```yaml
-repos:
--   repo: https://github.com/rvben/rumdl
-    rev: v0.0.45  # Use the latest release tag
-    hooks:
-    -   id: rumdl-check  # Just check for issues
-    # Or use rumdl-fix to automatically fix issues:
-    # -   id: rumdl-fix
-```
-
-Then run `pre-commit install`.
-
-Pre-commit will automatically download and install `rumdl` using `cargo`. `rumdl` will respect any `.rumdl.toml` or `pyproject.toml` configuration file present in your repository.
-
 ## License
 
 rumdl is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

{rumdl-0.0.45 → rumdl-0.0.47}/benches/range_performance.rs

@@ -1,11 +1,12 @@
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use rand::rng;
 use rand::Rng;
 use rumdl::rule::Rule;
 use rumdl::MD053LinkImageReferenceDefinitions;
 
 fn create_test_content(size: usize, ratio: f64) -> String {
     let mut content = String::with_capacity(size);
-    let mut rng = rand::thread_rng();
+    let mut rng = rng();
     let line_length = 80;
     let words_per_line = 10;
     let word_length = line_length / words_per_line;
@@ -14,9 +15,9 @@ fn create_test_content(size: usize, ratio: f64) -> String {
     content.push_str("# Test Document with References\n\n");
 
     for i in 0..100 {
-        if rng.gen::<f64>() < 0.5 {
+        if rng.random::<f64>() < 0.5 {
             // 50% chance to add a reference
-            if rng.gen::<f64>() < 0.7 {
+            if rng.random::<f64>() < 0.7 {
                 // 70% chance to be a link, 30% to be an image
                 content.push_str(&format!("[Link {}][ref-{}]\n", i, i));
             } else {
@@ -30,12 +31,12 @@ fn create_test_content(size: usize, ratio: f64) -> String {
     // Create paragraphs
     let num_paragraphs = size / (line_length * 5);
     for _ in 0..num_paragraphs {
-        let num_lines = rng.gen_range(3..7);
+        let num_lines = rng.random_range(3..7);
         for _ in 0..num_lines {
             for _ in 0..words_per_line {
-                let word_size = rng.gen_range(3..word_length);
+                let word_size = rng.random_range(3..word_length);
                 for _ in 0..word_size {
-                    let c = (b'a' + rng.gen_range(0..26)) as char;
+                    let c = (b'a' + rng.random_range(0..26)) as char;
                     content.push(c);
                 }
                 content.push(' ');
@@ -47,7 +48,7 @@ fn create_test_content(size: usize, ratio: f64) -> String {
 
     // Add reference definitions at the end
     for i in 0..100 {
-        if rng.gen::<f64>() < ratio {
+        if rng.random::<f64>() < ratio {
             // Only add a portion based on ratio
             content.push_str(&format!("[ref-{}]: https://example.com/ref-{}\n", i, i));
         }

{rumdl-0.0.45 → rumdl-0.0.47}/benches/range_utils_benchmark.rs

@@ -1,4 +1,6 @@
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use rand::rng;
+use rand::Rng;
 use rumdl::utils::range_utils::LineIndex;
 
 // Naive implementation that doesn't use the optimized function
@@ -78,14 +80,13 @@ fn bench_range_utils(c: &mut Criterion) {
     });
 
     // Benchmark with random accesses
-    use rand::prelude::*;
-    let mut rng = rand::thread_rng();
+    let mut rng = rng();
 
     c.bench_function("random_access_optimized", |b| {
         b.iter(|| {
             for _ in 0..20 {
-                let line = rng.gen_range(1..=line_count);
-                let col = rng.gen_range(1..=40);
+                let line = rng.random_range(1..=line_count);
+                let col = rng.random_range(1..=40);
                 black_box(line_index.line_col_to_byte_range(line, col));
             }
         })
@@ -94,8 +95,8 @@ fn bench_range_utils(c: &mut Criterion) {
     c.bench_function("random_access_naive", |b| {
         b.iter(|| {
             for _ in 0..20 {
-                let line = rng.gen_range(1..=line_count);
-                let col = rng.gen_range(1..=40);
+                let line = rng.random_range(1..=line_count);
+                let col = rng.random_range(1..=40);
                 black_box(naive_line_col_to_byte_range(black_box(&content), line, col));
             }
         })

{rumdl-0.0.45 → rumdl-0.0.47}/src/config.rs

@@ -47,7 +47,7 @@ pub struct GlobalConfig {
     /// Ignore .gitignore file
     #[serde(default)]
     pub ignore_gitignore: bool,
-    
+
     /// Respect .gitignore files when scanning directories
     #[serde(default = "default_respect_gitignore")]
     pub respect_gitignore: bool,
@@ -85,7 +85,7 @@ pub fn load_config(config_path: Option<&str>) -> Result<Config, ConfigError> {
             return load_config_from_file(filename);
         }
     }
-    
+
     // Check for pyproject.toml
     if Path::new("pyproject.toml").exists() {
         return load_config_from_pyproject("pyproject.toml");
@@ -115,13 +115,13 @@ fn load_config_from_pyproject(path: &str) -> Result<Config, ConfigError> {
         Ok(content) => {
             // Parse the entire pyproject.toml
             let pyproject: toml::Value = toml::from_str(&content)?;
-            
+
             // Try to extract [tool.rumdl] section
             match pyproject.get("tool").and_then(|t| t.get("rumdl")) {
                 Some(rumdl_config) => {
                     // Create a new Config with defaults
                     let mut config = Config::default();
-                    
+
                     // Parse the complete section into our configuration struct
                     if let Some(rumdl_table) = rumdl_config.as_table() {
                         // Extract global options from root level
@@ -130,85 +130,108 @@ fn load_config_from_pyproject(path: &str) -> Result<Config, ConfigError> {
                                 config.global.enable = values;
                             }
                         }
-                        
+
                         if let Some(disable) = rumdl_table.get("disable") {
                             if let Ok(values) = Vec::<String>::deserialize(disable.clone()) {
                                 config.global.disable = values;
                             }
                         }
-                        
+
                         if let Some(include) = rumdl_table.get("include") {
                             if let Ok(values) = Vec::<String>::deserialize(include.clone()) {
                                 config.global.include = values;
                             }
                         }
-                        
+
                         if let Some(exclude) = rumdl_table.get("exclude") {
                             if let Ok(values) = Vec::<String>::deserialize(exclude.clone()) {
                                 config.global.exclude = values;
                             }
                         }
-                        
-                        if let Some(ignore_gitignore) = rumdl_table.get("ignore-gitignore")
-                            .or_else(|| rumdl_table.get("ignore_gitignore")) {
+
+                        if let Some(ignore_gitignore) = rumdl_table
+                            .get("ignore-gitignore")
+                            .or_else(|| rumdl_table.get("ignore_gitignore"))
+                        {
                             if let Ok(value) = bool::deserialize(ignore_gitignore.clone()) {
                                 config.global.ignore_gitignore = value;
                             }
                         }
-                        
-                        if let Some(respect_gitignore) = rumdl_table.get("respect-gitignore")
-                            .or_else(|| rumdl_table.get("respect_gitignore")) {
+
+                        if let Some(respect_gitignore) = rumdl_table
+                            .get("respect-gitignore")
+                            .or_else(|| rumdl_table.get("respect_gitignore"))
+                        {
                             if let Ok(value) = bool::deserialize(respect_gitignore.clone()) {
                                 config.global.respect_gitignore = value;
                             }
                         }
-                        
+
                         // Handle line-length special case
-                        if let Some(line_length) = rumdl_table.get("line-length")
-                            .or_else(|| rumdl_table.get("line_length")) {
+                        if let Some(line_length) = rumdl_table
+                            .get("line-length")
+                            .or_else(|| rumdl_table.get("line_length"))
+                        {
                             // Create MD013 rule config if it doesn't exist
                             if !config.rules.contains_key("MD013") {
-                                config.rules.insert("MD013".to_string(), RuleConfig::default());
+                                config
+                                    .rules
+                                    .insert("MD013".to_string(), RuleConfig::default());
                             }
-                            
+
                             // Add line_length to the MD013 section
                             if let Some(rule_config) = config.rules.get_mut("MD013") {
-                                rule_config.values.insert("line_length".to_string(), line_length.clone());
+                                rule_config
+                                    .values
+                                    .insert("line_length".to_string(), line_length.clone());
                             }
                         }
-                        
+
                         // Extract rule-specific configurations
                         for (key, value) in rumdl_table {
                             // Skip keys that we've already processed as global options
-                            if ["enable", "disable", "include", "exclude", "ignore-gitignore", 
-                                "ignore_gitignore", "line-length", "line_length", 
-                                "respect-gitignore", "respect_gitignore"].contains(&key.as_str()) {
+                            if [
+                                "enable",
+                                "disable",
+                                "include",
+                                "exclude",
+                                "ignore-gitignore",
+                                "ignore_gitignore",
+                                "line-length",
+                                "line_length",
+                                "respect-gitignore",
+                                "respect_gitignore",
+                            ]
+                            .contains(&key.as_str())
+                            {
                                 continue;
                             }
-                            
+
                             // If it's a table, treat it as a rule configuration
                             if let Some(rule_table) = value.as_table() {
                                 let mut rule_config = RuleConfig::default();
-                                
+
                                 // Add all values from the table to the rule config
                                 for (rule_key, rule_value) in rule_table {
-                                    rule_config.values.insert(rule_key.to_string(), rule_value.clone());
+                                    rule_config
+                                        .values
+                                        .insert(rule_key.to_string(), rule_value.clone());
                                 }
-                                
+
                                 // Add to the config
                                 config.rules.insert(key.to_string(), rule_config);
                             }
                         }
                     }
-                    
+
                     Ok(config)
-                },
+                }
                 None => {
                     // No rumdl configuration found in pyproject.toml
                     Ok(Config::default())
                 }
             }
-        },
+        }
         Err(err) => Err(ConfigError::IoError {
             source: err,
             path: path.to_string(),
@@ -378,7 +401,7 @@ mod tests {
     fn test_pyproject_toml_root_level_config() {
         let temp_dir = tempdir().unwrap();
         let config_path = temp_dir.path().join("pyproject.toml");
-        
+
         // Create a test pyproject.toml with root-level configuration
         let content = r#"
 [tool.rumdl]
@@ -389,43 +412,46 @@ include = ["docs/*.md"]
 exclude = ["node_modules"]
 respect-gitignore = true
         "#;
-        
+
         fs::write(&config_path, content).unwrap();
-        
+
         // Load the config
         let config = load_config_from_pyproject(config_path.to_str().unwrap()).unwrap();
-        
+
         // Check global settings
         assert_eq!(config.global.disable, vec!["MD033".to_string()]);
-        assert_eq!(config.global.enable, vec!["MD001".to_string(), "MD004".to_string()]);
+        assert_eq!(
+            config.global.enable,
+            vec!["MD001".to_string(), "MD004".to_string()]
+        );
         assert_eq!(config.global.include, vec!["docs/*.md".to_string()]);
         assert_eq!(config.global.exclude, vec!["node_modules".to_string()]);
-        assert_eq!(config.global.respect_gitignore, true);
-        
+        assert!(config.global.respect_gitignore);
+
         // Check line_length was correctly added to MD013
         let line_length = get_rule_config_value::<usize>(&config, "MD013", "line_length");
         assert_eq!(line_length, Some(120));
     }
-    
+
     #[test]
     fn test_pyproject_toml_snake_case_and_kebab_case() {
         let temp_dir = tempdir().unwrap();
         let config_path = temp_dir.path().join("pyproject.toml");
-        
+
         // Test with both kebab-case and snake_case variants
         let content = r#"
 [tool.rumdl]
 line_length = 150
 respect_gitignore = true
         "#;
-        
+
         fs::write(&config_path, content).unwrap();
-        
+
         // Load the config
         let config = load_config_from_pyproject(config_path.to_str().unwrap()).unwrap();
-        
+
         // Check settings were correctly loaded
-        assert_eq!(config.global.respect_gitignore, true);
+        assert!(config.global.respect_gitignore);
         let line_length = get_rule_config_value::<usize>(&config, "MD013", "line_length");
         assert_eq!(line_length, Some(150));
     }