fix panic when formatting violations (#426)

fixes #425

Author: chdsbd

CHANGELOG.md

@@ -7,8 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## v1.6.1 - 2025-05-02
+
+### Fixed
+
+- Fixed panic when formatting violations (#426).
+
 ## v1.6.0 - 2025-04-02
 
+### Added
+
 - Added `ban-alter-domain-with-add-constraint` and `ban-create-domain-with-constraint` (#418). Thanks @johnmastro!
 
 ## v1.5.5 - 2025-03-20

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "squawk"
-version = "1.6.0"
+version = "1.6.1"
 authors = ["Steve Dignam <[email protected]>"]
 edition = "2018"
 license = "GPL-3.0"

cli/Cargo.toml

@@ -386,17 +386,28 @@ pub fn pretty_violations(
                 #[allow(clippy::cast_sign_loss)]
                 let start = start as usize;
 
-                // 1-indexed
-                // remove the leading whitespace on last line
-                let lineno = sql[..start].trim_end().lines().count() + 1;
+                let mut lineno = 0;
+
+                for (idx, char) in sql.chars().enumerate() {
+                    if char == '\n' {
+                        lineno += 1;
+                    }
+
+                    if idx == start {
+                        break;
+                    }
+                }
+
+                lineno += 1;
 
                 let content = if let Some(len) = len {
                     #[allow(clippy::cast_sign_loss)]
                     &sql[start..=start + len as usize]
                 } else {
                     // Use current line
                     let tail = sql[start..].find('\n').unwrap_or(sql.len() - start);
-                    &sql[start..=start + tail]
+
+                    &sql.chars().skip(start).take(tail + 1).collect::<String>()
                 };
 
                 // TODO(sbdchd): could remove the leading whitespace and comments to
@@ -666,6 +677,7 @@ mod test_reporter {
         check_sql_with_rule,
         violations::{RuleViolation, RuleViolationKind},
     };
+    use squawk_parser::ast::Span;
 
     fn lint_sql(sql: &str) -> Vec<RuleViolation> {
         check_sql_with_rule(sql, &RuleViolationKind::AddingRequiredField, None, false).unwrap()
@@ -825,4 +837,41 @@ SELECT 1;
         }
         "#);
     }
+
+    #[test]
+    fn regression_slicing_issue_425() {
+        // Squawk was crashing with an slicing issue.
+        let sql = "ALTER TABLE test ADD COLUMN IF NOT EXISTS test INTEGER;";
+        let violation = RuleViolation::new(
+            RuleViolationKind::PreferBigInt,
+            Span {
+                start: 42,
+                len: None,
+            },
+            None,
+        );
+        pretty_violations(vec![violation], sql, "main.sql");
+    }
+    #[test]
+    fn highlight_column_for_issues() {
+        // Display only the columns with issues for large DDLs.
+        fn lint_sql(sql: &str) -> Vec<RuleViolation> {
+            check_sql_with_rule(sql, &RuleViolationKind::PreferTextField, None, false).unwrap()
+        }
+        // Squawk was crashing with an slicing issue.
+        let sql = "create table test_table (
+    col1 varchar(255),
+    col2 varchar(255),
+    col3 varchar(255)
+    --- other columns
+);";
+        let violations = lint_sql(sql);
+        let res = pretty_violations(violations, sql, "main.sql");
+        let columns = res
+            .violations
+            .iter()
+            .map(|v| v.sql.clone())
+            .collect::<String>();
+        assert_display_snapshot!(columns);
+    }
 }

cli/src/reporter.rs

@@ -0,0 +1,8 @@
+---
+source: cli/src/reporter.rs
+expression: columns
+---
+col1 varchar(255),
+col2 varchar(255),
+col3 varchar(255)
+

cli/src/snapshots/squawk__reporter__test_reporter__highlight_column_for_issues.snap

@@ -8,7 +8,7 @@ ViolationContent {
     violations: [
         ReportViolation {
             file: "main.sql",
-            line: 1,
+            line: 2,
             column: 2,
             level: Warning,
             messages: [

cli/src/snapshots/squawk__reporter__test_reporter__span_offsets.snap

@@ -18,7 +18,7 @@
           {
             squawk = final.rustPlatform.buildRustPackage {
               pname = "squawk";
-              version = "1.6.0";
+              version = "1.6.1";
 
               cargoLock = {
                 lockFile = ./Cargo.lock;

flake.nix

@@ -1,6 +1,6 @@
 {
   "name": "squawk-cli",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "linter for PostgreSQL, focused on migrations",
   "repository": "[email protected]:sbdchd/squawk.git",
   "author": "Steve Dignam <[email protected]>",