rumdl 0.0.121__tar.gz → 0.0.122__tar.gz

{rumdl-0.0.121 → rumdl-0.0.122}/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.122] - 2025-08-19
+
 ## [0.0.121] - 2025-08-19
 
 ### Fixed
@@ -370,7 +372,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.121...HEAD
+[Unreleased]: https://github.com/rvben/rumdl/compare/v0.0.122...HEAD
+[0.0.122]: https://github.com/rvben/rumdl/compare/v0.0.121...v0.0.122
 [0.0.121]: https://github.com/rvben/rumdl/compare/v0.0.120...v0.0.121
 [0.0.120]: https://github.com/rvben/rumdl/compare/v0.0.119...v0.0.120
 [0.0.119]: https://github.com/rvben/rumdl/compare/v0.0.118...v0.0.119

{rumdl-0.0.121 → rumdl-0.0.122}/Cargo.lock

@@ -229,9 +229,9 @@ dependencies = [
 
 [[package]]
 name = "cfg-if"
-version = "1.0.1"
+version = "1.0.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9555578bc9e57714c812a1f84e4fc5b4d21fcb063490c624de019f7464c91268"
+checksum = "2fd1289c04a9ea8cb22300a459a72a385d7c73d3259e2ed7dcb2af674838cfa9"
 
 [[package]]
 name = "chrono"
@@ -1493,7 +1493,7 @@ checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
 
 [[package]]
 name = "rumdl"
-version = "0.0.121"
+version = "0.0.122"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.121 → rumdl-0.0.122}/Cargo.toml

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

{rumdl-0.0.121 → rumdl-0.0.122}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.121
+Version: 0.0.122
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -96,6 +96,8 @@ It offers:
     - [VS Code Extension](#vs-code-extension)
   - [Usage](#usage)
   - [Pre-commit Integration](#pre-commit-integration)
+  - [CI/CD Integration](#cicd-integration)
+    - [GitHub Actions](#github-actions)
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
@@ -270,6 +272,19 @@ repos:
 
 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.
 
+## CI/CD Integration
+
+### GitHub Actions
+
+rumdl can output annotations directly in GitHub Actions format, making issues appear inline in pull requests:
+
+```yaml
+- name: Lint Markdown
+  run: rumdl check --output-format github .
+```
+
+This produces annotations that GitHub automatically displays in the PR's "Files changed" tab. Supports error/warning severity levels and precise issue locations.
+
 ## Rules
 
 rumdl implements 54 lint rules for Markdown files. Here are some key rule categories:

{rumdl-0.0.121 → rumdl-0.0.122}/README.md

@@ -67,6 +67,8 @@ It offers:
     - [VS Code Extension](#vs-code-extension)
   - [Usage](#usage)
   - [Pre-commit Integration](#pre-commit-integration)
+  - [CI/CD Integration](#cicd-integration)
+    - [GitHub Actions](#github-actions)
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
@@ -241,6 +243,19 @@ repos:
 
 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.
 
+## CI/CD Integration
+
+### GitHub Actions
+
+rumdl can output annotations directly in GitHub Actions format, making issues appear inline in pull requests:
+
+```yaml
+- name: Lint Markdown
+  run: rumdl check --output-format github .
+```
+
+This produces annotations that GitHub automatically displays in the PR's "Files changed" tab. Supports error/warning severity levels and precise issue locations.
+
 ## Rules
 
 rumdl implements 54 lint rules for Markdown files. Here are some key rule categories:

{rumdl-0.0.121 → rumdl-0.0.122}/src/output/formatters/github.rs

@@ -1,10 +1,13 @@
 //! GitHub Actions annotation format
+//!
+//! Outputs annotations in GitHub Actions workflow command format for PR annotations.
+//! See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions
 
 use crate::output::OutputFormatter;
-use crate::rule::LintWarning;
+use crate::rule::{LintWarning, Severity};
 
 /// GitHub Actions formatter
-/// Outputs in the format: ::error file=<file>,line=<line>,col=<col>,title=<rule>::<message>
+/// Outputs in the format: ::<level> file=<file>,line=<line>,col=<col>,endLine=<endLine>,endColumn=<endCol>,title=<rule>::<message>
 pub struct GitHubFormatter;
 
 impl Default for GitHubFormatter {
@@ -17,6 +20,24 @@ impl GitHubFormatter {
     pub fn new() -> Self {
         Self
     }
+
+    /// Escape special characters according to GitHub Actions specification
+    /// Percent-encodes: %, \r, \n, :, ,
+    /// Used for property values (file, title, etc.)
+    fn escape_property(value: &str) -> String {
+        value
+            .replace('%', "%25")
+            .replace('\r', "%0D")
+            .replace('\n', "%0A")
+            .replace(':', "%3A")
+            .replace(',', "%2C")
+    }
+
+    /// Escape special characters in the message part
+    /// Percent-encodes: %, \r, \n
+    fn escape_message(value: &str) -> String {
+        value.replace('%', "%25").replace('\r', "%0D").replace('\n', "%0A")
+    }
 }
 
 impl OutputFormatter for GitHubFormatter {
@@ -26,12 +47,38 @@ impl OutputFormatter for GitHubFormatter {
         for warning in warnings {
             let rule_name = warning.rule_name.unwrap_or("unknown");
 
-            // GitHub Actions annotation format
-            // Use "warning" level since these are linting warnings, not errors
-            let line = format!(
-                "::warning file={},line={},col={},title={}::{}",
-                file_path, warning.line, warning.column, rule_name, warning.message
-            );
+            // Map severity to GitHub Actions annotation level
+            let level = match warning.severity {
+                Severity::Error => "error",
+                Severity::Warning => "warning",
+            };
+
+            // Escape special characters in all properties
+            let escaped_file = Self::escape_property(file_path);
+            let escaped_rule = Self::escape_property(rule_name);
+            let escaped_message = Self::escape_message(&warning.message);
+
+            // GitHub Actions annotation format with optional end position
+            let line = if warning.end_line != warning.line || warning.end_column != warning.column {
+                // Include end position if different from start
+                format!(
+                    "::{} file={},line={},col={},endLine={},endColumn={},title={}::{}",
+                    level,
+                    escaped_file,
+                    warning.line,
+                    warning.column,
+                    warning.end_line,
+                    warning.end_column,
+                    escaped_rule,
+                    escaped_message
+                )
+            } else {
+                // Omit end position if same as start
+                format!(
+                    "::{} file={},line={},col={},title={}::{}",
+                    level, escaped_file, warning.line, warning.column, escaped_rule, escaped_message
+                )
+            };
 
             output.push_str(&line);
             output.push('\n');
@@ -88,7 +135,7 @@ mod tests {
         let output = formatter.format_warnings(&warnings, "README.md");
         assert_eq!(
             output,
-            "::warning file=README.md,line=10,col=5,title=MD001::Heading levels should only increment by one level at a time"
+            "::warning file=README.md,line=10,col=5,endLine=10,endColumn=15,title=MD001::Heading levels should only increment by one level at a time"
         );
     }
 
@@ -119,7 +166,7 @@ mod tests {
         ];
 
         let output = formatter.format_warnings(&warnings, "test.md");
-        let expected = "::warning file=test.md,line=5,col=1,title=MD001::First warning\n::warning file=test.md,line=10,col=3,title=MD013::Second warning";
+        let expected = "::warning file=test.md,line=5,col=1,endLine=5,endColumn=10,title=MD001::First warning\n::error file=test.md,line=10,col=3,endLine=10,endColumn=20,title=MD013::Second warning";
         assert_eq!(output, expected);
     }
 
@@ -141,10 +188,10 @@ mod tests {
         }];
 
         let output = formatter.format_warnings(&warnings, "doc.md");
-        // GitHub format doesn't show fix indicator
+        // GitHub format doesn't show fix indicator but includes end position
         assert_eq!(
             output,
-            "::warning file=doc.md,line=15,col=1,title=MD022::Headings should be surrounded by blank lines"
+            "::warning file=doc.md,line=15,col=1,endLine=15,endColumn=10,title=MD022::Headings should be surrounded by blank lines"
         );
     }
 
@@ -165,7 +212,7 @@ mod tests {
         let output = formatter.format_warnings(&warnings, "file.md");
         assert_eq!(
             output,
-            "::warning file=file.md,line=1,col=1,title=unknown::Unknown rule warning"
+            "::warning file=file.md,line=1,col=1,endLine=1,endColumn=5,title=unknown::Unknown rule warning"
         );
     }
 
@@ -188,7 +235,7 @@ mod tests {
         let output = formatter.format_warnings(&warnings, "large.md");
         assert_eq!(
             output,
-            "::warning file=large.md,line=99999,col=12345,title=MD999::Edge case warning"
+            "::error file=large.md,line=99999,col=12345,endLine=100000,endColumn=12350,title=MD999::Edge case warning"
         );
     }
 
@@ -207,10 +254,32 @@ mod tests {
         }];
 
         let output = formatter.format_warnings(&warnings, "test.md");
-        // Note: GitHub Actions should handle special characters in messages
+        // Newline should be escaped as %0A
+        assert_eq!(
+            output,
+            "::warning file=test.md,line=1,col=1,endLine=1,endColumn=5,title=MD001::Warning with \"quotes\" and 'apostrophes' and %0A newline"
+        );
+    }
+
+    #[test]
+    fn test_percent_encoding() {
+        let formatter = GitHubFormatter::new();
+        let warnings = vec![LintWarning {
+            line: 1,
+            column: 1,
+            end_line: 1,
+            end_column: 1,
+            rule_name: Some("MD001"),
+            message: "100% complete\r\nNew line".to_string(),
+            severity: Severity::Warning,
+            fix: None,
+        }];
+
+        let output = formatter.format_warnings(&warnings, "test%.md");
+        // %, \r, and \n should be encoded
         assert_eq!(
             output,
-            "::warning file=test.md,line=1,col=1,title=MD001::Warning with \"quotes\" and 'apostrophes' and \n newline"
+            "::warning file=test%25.md,line=1,col=1,title=MD001::100%25 complete%0D%0ANew line"
         );
     }
 
@@ -231,7 +300,7 @@ mod tests {
         let output = formatter.format_warnings(&warnings, "path/with spaces/and-dashes.md");
         assert_eq!(
             output,
-            "::warning file=path/with spaces/and-dashes.md,line=1,col=1,title=MD001::Test"
+            "::warning file=path/with spaces/and-dashes.md,line=1,col=1,endLine=1,endColumn=5,title=MD001::Test"
         );
     }
 
@@ -256,15 +325,17 @@ mod tests {
         assert!(output.contains("file=test.md"));
         assert!(output.contains("line=42"));
         assert!(output.contains("col=7"));
+        assert!(output.contains("endLine=42"));
+        assert!(output.contains("endColumn=10"));
         assert!(output.contains("title=MD010"));
         assert!(output.ends_with("::Hard tabs"));
     }
 
     #[test]
-    fn test_severity_always_warning() {
+    fn test_severity_mapping() {
         let formatter = GitHubFormatter::new();
 
-        // Test that all severities are output as "warning" in GitHub format
+        // Test that severities are properly mapped
         let warnings = vec![
             LintWarning {
                 line: 1,
@@ -291,16 +362,16 @@ mod tests {
         let output = formatter.format_warnings(&warnings, "test.md");
         let lines: Vec<&str> = output.lines().collect();
 
-        // Both should use ::warning regardless of severity
+        // Warning should use ::warning, Error should use ::error
         assert!(lines[0].starts_with("::warning "));
-        assert!(lines[1].starts_with("::warning "));
+        assert!(lines[1].starts_with("::error "));
     }
 
     #[test]
     fn test_commas_in_parameters() {
         let formatter = GitHubFormatter::new();
 
-        // Test that commas in the title don't break the format
+        // Test that commas in the title and file path are properly escaped
         let warnings = vec![LintWarning {
             line: 1,
             column: 1,
@@ -313,10 +384,80 @@ mod tests {
         }];
 
         let output = formatter.format_warnings(&warnings, "file,with,commas.md");
-        // The format should still be parseable by GitHub Actions
+        // Commas in properties should be escaped as %2C
+        assert_eq!(
+            output,
+            "::warning file=file%2Cwith%2Ccommas.md,line=1,col=1,endLine=1,endColumn=5,title=MD%2C001::Test message, with comma"
+        );
+    }
+
+    #[test]
+    fn test_colons_in_parameters() {
+        let formatter = GitHubFormatter::new();
+
+        // Test that colons in file path and rule name are properly escaped
+        let warnings = vec![LintWarning {
+            line: 1,
+            column: 1,
+            end_line: 1,
+            end_column: 5,
+            rule_name: Some("MD:001"), // Unlikely but test edge case
+            message: "Test message: with colon".to_string(),
+            severity: Severity::Warning,
+            fix: None,
+        }];
+
+        let output = formatter.format_warnings(&warnings, "file:with:colons.md");
+        // Colons in properties should be escaped as %3A, but not in message
+        assert_eq!(
+            output,
+            "::warning file=file%3Awith%3Acolons.md,line=1,col=1,endLine=1,endColumn=5,title=MD%3A001::Test message: with colon"
+        );
+    }
+
+    #[test]
+    fn test_same_start_end_position() {
+        let formatter = GitHubFormatter::new();
+
+        // When start and end are the same, end position should be omitted
+        let warnings = vec![LintWarning {
+            line: 5,
+            column: 10,
+            end_line: 5,
+            end_column: 10,
+            rule_name: Some("MD001"),
+            message: "Single position warning".to_string(),
+            severity: Severity::Warning,
+            fix: None,
+        }];
+
+        let output = formatter.format_warnings(&warnings, "test.md");
+        // Should not include endLine and endColumn when they're the same as line and column
+        assert_eq!(
+            output,
+            "::warning file=test.md,line=5,col=10,title=MD001::Single position warning"
+        );
+    }
+
+    #[test]
+    fn test_error_severity() {
+        let formatter = GitHubFormatter::new();
+
+        let warnings = vec![LintWarning {
+            line: 1,
+            column: 1,
+            end_line: 1,
+            end_column: 5,
+            rule_name: Some("MD001"),
+            message: "Error level issue".to_string(),
+            severity: Severity::Error,
+            fix: None,
+        }];
+
+        let output = formatter.format_warnings(&warnings, "test.md");
         assert_eq!(
             output,
-            "::warning file=file,with,commas.md,line=1,col=1,title=MD,001::Test message, with comma"
+            "::error file=test.md,line=1,col=1,endLine=1,endColumn=5,title=MD001::Error level issue"
         );
     }
 }

{rumdl-0.0.121 → rumdl-0.0.122}/tests/comprehensive_output_format_tests.rs

@@ -126,8 +126,13 @@ fn test_github_output_format() {
     cmd.assert()
         .failure()
         .stdout(predicate::str::contains("::warning file="))
-        .stdout(predicate::str::contains("line=1,col=1,title=MD022::"))
-        .stdout(predicate::str::contains("line=2,col=28,title=MD009::"));
+        .stdout(predicate::str::contains("line=1,col=1,"))
+        .stdout(predicate::str::contains("title=MD022::"))
+        .stdout(predicate::str::contains("line=2,col=28,"))
+        .stdout(predicate::str::contains("title=MD009::"))
+        // Also check for new endLine/endColumn parameters
+        .stdout(predicate::str::contains("endLine="))
+        .stdout(predicate::str::contains("endColumn="));
 }
 
 #[test]