squawk-cli 2.26.0__tar.gz → 2.28.0__tar.gz

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/Cargo.lock

@@ -57,6 +57,15 @@ version = "1.0.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "862ed96ca487e809f1c8e5a8447f6ee2cf102f846893800b20cebdf541fc6bbd"
 
+[[package]]
+name = "anstyle-lossy"
+version = "1.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "04d3a5dc826f84d0ea11882bb8054ff7f3d482602e11bb181101303a279ea01f"
+dependencies = [
+ "anstyle",
+]
+
 [[package]]
 name = "anstyle-parse"
 version = "0.2.7"
@@ -75,6 +84,19 @@ dependencies = [
  "windows-sys 0.60.2",
 ]
 
+[[package]]
+name = "anstyle-svg"
+version = "0.1.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "26b9ec8c976eada1b0f9747a3d7cc4eae3bef10613e443746e7487f26c872fde"
+dependencies = [
+ "anstyle",
+ "anstyle-lossy",
+ "anstyle-parse",
+ "html-escape",
+ "unicode-width 0.2.1",
+]
+
 [[package]]
 name = "anstyle-wincon"
 version = "3.0.10"
@@ -664,6 +686,15 @@ dependencies = [
  "windows-sys 0.59.0",
 ]
 
+[[package]]
+name = "html-escape"
+version = "0.2.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6d1ad449764d627e22bfd7cd5e8868264fc9236e07c752972b4080cd351cb476"
+dependencies = [
+ "utf8-width",
+]
+
 [[package]]
 name = "http"
 version = "0.2.12"
@@ -1119,6 +1150,12 @@ dependencies = [
  "minimal-lexical",
 ]
 
+[[package]]
+name = "normalize-line-endings"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61807f77802ff30975e01f4f071c8ba10c022052f98b3294119f3e615d13e5be"
+
 [[package]]
 name = "num-bigint"
 version = "0.4.6"
@@ -1237,6 +1274,16 @@ dependencies = [
  "vcpkg",
 ]
 
+[[package]]
+name = "os_pipe"
+version = "1.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "db335f4760b14ead6290116f2427bf33a14d4f0617d49f78a246de10c1831224"
+dependencies = [
+ "libc",
+ "windows-sys 0.59.0",
+]
+
 [[package]]
 name = "peeking_take_while"
 version = "0.1.2"
@@ -1734,6 +1781,34 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "snapbox"
+version = "0.6.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "96dcfc4581e3355d70ac2ee14cfdf81dce3d85c85f1ed9e2c1d3013f53b3436b"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "anstyle-svg",
+ "libc",
+ "normalize-line-endings",
+ "os_pipe",
+ "serde_json",
+ "similar",
+ "snapbox-macros",
+ "wait-timeout",
+ "windows-sys 0.59.0",
+]
+
+[[package]]
+name = "snapbox-macros"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "16569f53ca23a41bb6f62e0a5084aa1661f4814a67fa33696a79073e03a664af"
+dependencies = [
+ "anstream",
+]
+
 [[package]]
 name = "socket2"
 version = "0.5.10"
@@ -1756,7 +1831,7 @@ dependencies = [
 
 [[package]]
 name = "squawk"
-version = "2.26.0"
+version = "2.28.0"
 dependencies = [
  "annotate-snippets",
  "anyhow",
@@ -1773,18 +1848,19 @@ dependencies = [
  "serde",
  "serde_json",
  "simplelog",
- "squawk_github",
- "squawk_lexer",
- "squawk_linter",
- "squawk_server",
- "squawk_syntax",
+ "snapbox",
+ "squawk-github",
+ "squawk-lexer",
+ "squawk-linter",
+ "squawk-server",
+ "squawk-syntax",
  "tempfile",
  "toml",
 ]
 
 [[package]]
-name = "squawk_github"
-version = "2.26.0"
+name = "squawk-github"
+version = "2.28.0"
 dependencies = [
  "jsonwebtoken",
  "log",
@@ -1794,15 +1870,15 @@ dependencies = [
 ]
 
 [[package]]
-name = "squawk_lexer"
-version = "2.26.0"
+name = "squawk-lexer"
+version = "2.28.0"
 dependencies = [
  "insta",
 ]
 
 [[package]]
-name = "squawk_linter"
-version = "2.26.0"
+name = "squawk-linter"
+version = "2.28.0"
 dependencies = [
  "enum-iterator",
  "insta",
@@ -1811,25 +1887,25 @@ dependencies = [
  "rowan",
  "serde",
  "serde_plain",
- "squawk_syntax",
+ "squawk-syntax",
 ]
 
 [[package]]
-name = "squawk_parser"
-version = "2.26.0"
+name = "squawk-parser"
+version = "2.28.0"
 dependencies = [
  "camino",
  "dir-test",
  "drop_bomb",
  "insta",
  "pg_query",
- "squawk_lexer",
+ "squawk-lexer",
  "xshell",
 ]
 
 [[package]]
-name = "squawk_server"
-version = "2.26.0"
+name = "squawk-server"
+version = "2.28.0"
 dependencies = [
  "anyhow",
  "insta",
@@ -1840,26 +1916,26 @@ dependencies = [
  "serde",
  "serde_json",
  "simplelog",
- "squawk_lexer",
- "squawk_linter",
- "squawk_syntax",
+ "squawk-lexer",
+ "squawk-linter",
+ "squawk-syntax",
 ]
 
 [[package]]
-name = "squawk_syntax"
-version = "2.26.0"
+name = "squawk-syntax"
+version = "2.28.0"
 dependencies = [
  "camino",
  "dir-test",
  "insta",
  "rowan",
  "smol_str",
- "squawk_parser",
+ "squawk-parser",
 ]
 
 [[package]]
-name = "squawk_wasm"
-version = "2.26.0"
+name = "squawk-wasm"
+version = "2.28.0"
 dependencies = [
  "console_error_panic_hook",
  "console_log",
@@ -1867,9 +1943,9 @@ dependencies = [
  "log",
  "serde",
  "serde-wasm-bindgen",
- "squawk_lexer",
- "squawk_linter",
- "squawk_syntax",
+ "squawk-lexer",
+ "squawk-linter",
+ "squawk-syntax",
  "wasm-bindgen",
  "wasm-bindgen-test",
  "web-sys",
@@ -2194,6 +2270,12 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "utf8-width"
+version = "0.1.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "86bd8d4e895da8537e5315b8254664e6b769c4ff3db18321b297a1e7004392e3"
+
 [[package]]
 name = "utf8_iter"
 version = "1.0.4"
@@ -2212,6 +2294,15 @@ version = "0.2.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426"
 
+[[package]]
+name = "wait-timeout"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09ac3b126d3914f9849036f826e054cbabdc8519970b8998ddaf3b5bd3c65f11"
+dependencies = [
+ "libc",
+]
+
 [[package]]
 name = "walkdir"
 version = "2.5.0"
@@ -2661,7 +2752,7 @@ checksum = "32ac00cd3f8ec9c1d33fb3e7958a82df6989c42d747bd326c822b1d625283547"
 
 [[package]]
 name = "xtask"
-version = "2.26.0"
+version = "2.28.0"
 dependencies = [
  "anyhow",
  "camino",

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/Cargo.toml

@@ -3,11 +3,15 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
-version = "2.26.0"
+version = "2.28.0"
 edition = "2024"
-rust-version = "1.88.0"
+rust-version = "1.90.0"
 authors = ["Squawk Team & Contributors"]
 license = "Apache-2.0 OR MIT"
+description = "Linter for Postgres migrations & SQL"
+documentation = "https://squawkhq.com/docs/"
+homepage = "https://squawkhq.com"
+repository = "https://github.com/sbdchd/squawk"
 
 [workspace.dependencies]
 # third party
@@ -51,14 +55,16 @@ ungrammar = "1.1.4"
 quote = "1.0.40"
 xshell = "0.2.7"
 proc-macro2 = "1.0.95"
+snapbox = { version = "0.6.0", features = ["diff", "term-svg", "cmd"] }
 
 # local
-squawk_github = { path = "./crates/squawk_github" }
-squawk_lexer = { path = "./crates/squawk_lexer" }
-squawk_parser = { path = "./crates/squawk_parser" }
-squawk_syntax = { path = "./crates/squawk_syntax" }
-squawk_linter = { path = "./crates/squawk_linter" }
-squawk_server = { path = "./crates/squawk_server" }
+# we have to make the versions explicit otherwise `cargo publish` won't work
+squawk-github = { path = "./crates/squawk_github", version = "2.27.0" }
+squawk-lexer = { path = "./crates/squawk_lexer", version = "2.27.0" }
+squawk-parser = { path = "./crates/squawk_parser", version = "2.27.0" }
+squawk-syntax = { path = "./crates/squawk_syntax", version = "2.27.0" }
+squawk-linter = { path = "./crates/squawk_linter", version = "2.27.0" }
+squawk-server = { path = "./crates/squawk_server", version = "2.27.0" }
 
 [workspace.lints.clippy]
 collapsible_else_if = "allow"

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: squawk-cli
-Version: 2.26.0
+Version: 2.28.0
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: MacOS
@@ -11,4 +11,5 @@ Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Summary: Linter for PostgreSQL migrations
+Home-Page: https://squawkhq.com
 Requires-Python: >=3.8

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/crates/squawk/Cargo.toml

@@ -7,8 +7,9 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 description = "Linter for Postgresql focused on database migrations."
-repository = "https://github.com/sbdchd/squawk"
-documentation = "https://github.com/sbdchd/squawk/blob/master/README.md"
+documentation.workspace = true
+homepage.workspace = true
+repository.workspace = true
 readme = "README.md"
 keywords = ["postgres", "postgresql", "linter"]
 categories = ["command-line-utilities", "development-tools"]
@@ -25,11 +26,11 @@ base64.workspace = true
 simplelog.workspace = true
 log.workspace = true
 enum-iterator.workspace = true
-squawk_syntax.workspace = true
-squawk_linter.workspace = true
-squawk_lexer.workspace = true
-squawk_github.workspace = true
-squawk_server.workspace = true
+squawk-syntax.workspace = true
+squawk-linter.workspace = true
+squawk-lexer.workspace = true
+squawk-github.workspace = true
+squawk-server.workspace = true
 toml.workspace = true
 glob.workspace = true
 anyhow.workspace = true
@@ -40,6 +41,7 @@ lsp-types.workspace = true
 
 [dev-dependencies]
 insta.workspace = true
+snapbox.workspace = true
 
 [lints]
 workspace = true

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/crates/squawk/README.md

@@ -45,50 +45,64 @@ Use the WASM powered playground to check your SQL locally in the browser!
 ```shell
 ❯ squawk example.sql
 warning[prefer-bigint-over-int]: Using 32-bit integer fields can result in hitting the max `int` limit.
- --> example.sql:6:10
-  |
-6 |     "id" serial NOT NULL PRIMARY KEY,
-  |          ------
-  |
-  = help: Use 64-bit integer values instead to prevent hitting this limit.
+  ╭▸ example.sql:6:10
+  │
+6 │     "id" serial NOT NULL PRIMARY KEY,
+  │          ━━━━━━
+  │
+  ├ help: Use 64-bit integer values instead to prevent hitting this limit.
+  ╭╴
+6 │     "id" bigserial NOT NULL PRIMARY KEY,
+  ╰╴         +++
 warning[prefer-identity]: Serial types make schema, dependency, and permission management difficult.
- --> example.sql:6:10
-  |
-6 |     "id" serial NOT NULL PRIMARY KEY,
-  |          ------
-  |
-  = help: Use Identity columns instead.
+  ╭▸ example.sql:6:10
+  │
+6 │     "id" serial NOT NULL PRIMARY KEY,
+  │          ━━━━━━
+  │
+  ├ help: Use an `IDENTITY` column instead.
+  ╭╴
+6 -     "id" serial NOT NULL PRIMARY KEY,
+6 +     "id" integer generated by default as identity NOT NULL PRIMARY KEY,
+  ╰╴
 warning[prefer-text-field]: Changing the size of a `varchar` field requires an `ACCESS EXCLUSIVE` lock, that will prevent all reads and writes to the table.
- --> example.sql:7:13
-  |
-7 |     "alpha" varchar(100) NOT NULL
-  |             ------------
-  |
-  = help: Use a `TEXT` field with a `CHECK` constraint.
+  ╭▸ example.sql:7:13
+  │
+7 │     "alpha" varchar(100) NOT NULL
+  │             ━━━━━━━━━━━━
+  │
+  ├ help: Use a `TEXT` field with a `CHECK` constraint.
+  ╭╴
+7 -     "alpha" varchar(100) NOT NULL
+7 +     "alpha" text NOT NULL
+  ╰╴
 warning[require-concurrent-index-creation]: During normal index creation, table updates are blocked, but reads are still allowed.
-  --> example.sql:10:1
-   |
-10 | CREATE INDEX "field_name_idx" ON "table_name" ("field_name");
-   | ------------------------------------------------------------
-   |
-   = help: Use `CONCURRENTLY` to avoid blocking writes.
+   ╭▸ example.sql:10:1
+   │
+10 │ CREATE INDEX "field_name_idx" ON "table_name" ("field_name");
+   │ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+   │
+   ├ help: Use `concurrently` to avoid blocking writes.
+   ╭╴
+10 │ CREATE INDEX concurrently "field_name_idx" ON "table_name" ("field_name");
+   ╰╴             ++++++++++++
 warning[constraint-missing-not-valid]: By default new constraints require a table scan and block writes to the table while that scan occurs.
-  --> example.sql:12:24
-   |
-12 | ALTER TABLE table_name ADD CONSTRAINT field_name_constraint UNIQUE (field_name);
-   |                        --------------------------------------------------------
-   |
-   = help: Use `NOT VALID` with a later `VALIDATE CONSTRAINT` call.
+   ╭▸ example.sql:12:24
+   │
+12 │ ALTER TABLE table_name ADD CONSTRAINT field_name_constraint UNIQUE (field_name);
+   │                        ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+   │
+   ╰ help: Use `NOT VALID` with a later `VALIDATE CONSTRAINT` call.
 warning[disallowed-unique-constraint]: Adding a `UNIQUE` constraint requires an `ACCESS EXCLUSIVE` lock which blocks reads and writes to the table while the index is built.
-  --> example.sql:12:28
-   |
-12 | ALTER TABLE table_name ADD CONSTRAINT field_name_constraint UNIQUE (field_name);
-   |                            ----------------------------------------------------
-   |
-   = help: Create an index `CONCURRENTLY` and create the constraint using the index.
+   ╭▸ example.sql:12:28
+   │
+12 │ ALTER TABLE table_name ADD CONSTRAINT field_name_constraint UNIQUE (field_name);
+   │                            ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+   │
+   ╰ help: Create an index `CONCURRENTLY` and create the constraint using the index.
 
 Find detailed examples and solutions for each rule at https://squawkhq.com/docs/rules
-Found 7 issues in 1 file (checked 1 source file)
+Found 6 issues in 1 file (checked 1 source file)
 ```
 
 ### `squawk --help`

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/crates/squawk/src/config.rs

@@ -137,4 +137,14 @@ fail_on_violations = true
         fs::write(&squawk_toml, file).expect("Unable to write file");
         assert_debug_snapshot!(Config::parse(Some(squawk_toml.path().to_path_buf())));
     }
+    #[test]
+    fn load_excluded_rules_with_alias() {
+        let squawk_toml = NamedTempFile::new().expect("generate tempFile");
+        let file = r#"
+excluded_rules = ["prefer-timestamp-tz", "prefer-timestamptz"]
+
+        "#;
+        fs::write(&squawk_toml, file).expect("Unable to write file");
+        assert_debug_snapshot!(Config::parse(Some(squawk_toml.path().to_path_buf())));
+    }
 }

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/crates/squawk/src/debug.rs

@@ -1,8 +1,6 @@
 use std::{io, path::PathBuf};
 
-use annotate_snippets::{
-    Annotation, AnnotationKind, Level, Renderer, Snippet, renderer::DecorStyle,
-};
+use annotate_snippets::{AnnotationKind, Level, Renderer, Snippet, renderer::DecorStyle};
 use anyhow::Result;
 use serde_json::json;
 use squawk_syntax::{ast::AstNode, syntax_error::SyntaxError};

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/crates/squawk/src/github.rs

@@ -394,6 +394,7 @@ mod test_github_comment {
                 help: Some("Make the field nullable.".to_string()),
                 column_end: 9,
                 line_end: 1,
+                fix: None,
             }],
         }];
 
@@ -486,6 +487,7 @@ ALTER TABLE "core_recipe" ADD COLUMN "foo" integer DEFAULT 10;
                 help: Some("Use bigint instead.".to_string()),
                 column_end: 0,
                 line_end: 1,
+                fix: None,
             }],
         }];
 
@@ -520,6 +522,7 @@ ALTER TABLE "core_recipe" ADD COLUMN "foo" integer DEFAULT 10;
                 help: Some("Use bigint instead.".to_string()),
                 column_end: 0,
                 line_end: 1,
+                fix: None,
             }],
         }];
 

{squawk_cli-2.26.0 → squawk_cli-2.28.0}/crates/squawk/src/main.rs

@@ -60,7 +60,7 @@ pub enum Command {
     /// Run the language server
     Server,
     /// Comment on a PR with Squawk's results.
-    UploadToGithub(UploadToGithubArgs),
+    UploadToGithub(Box<UploadToGithubArgs>),
 }
 
 #[derive(Debug, ValueEnum, Clone)]
@@ -232,7 +232,7 @@ Please open an issue at https://github.com/sbdchd/squawk/issues/new with the log
         }
         Some(Command::UploadToGithub(args)) => {
             github::check_and_comment_on_pr(
-                args,
+                *args,
                 &conf,
                 is_stdin,
                 opts.stdin_filepath,