squawk-cli 1.5.5__tar.gz → 1.6.1__tar.gz

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/Cargo.lock

@@ -1586,7 +1586,7 @@ checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"
 
 [[package]]
 name = "squawk"
-version = "1.5.5"
+version = "1.6.1"
 dependencies = [
  "atty",
  "base64 0.12.3",

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: squawk-cli
-Version: 1.5.5
+Version: 1.6.1
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
@@ -193,13 +193,13 @@ See the ["GitHub Integration" docs](https://squawkhq.com/docs/github_app) for mo
 Integrate Squawk into Git workflow with [pre-commit](https://pre-commit.com/). Add the following
 to your project's `.pre-commit-config.yaml`:
 
-```
+```yaml
 repos:
   - repo: https://github.com/sbdchd/squawk
     rev: v0.10.0
     hooks:
-     - id: squawk
-       files: path/to/postres/migrations/written/in/sql
+      - id: squawk
+        files: path/to/postgres/migrations/written/in/sql
 ```
 
 Note the `files` parameter as it specifies the location of the files to be linted.
@@ -217,6 +217,7 @@ Note the `files` parameter as it specifies the location of the files to be linte
 - <https://github.com/AdmTal/PostgreSQL-Query-Lock-Explainer>
 - <https://github.com/stripe/pg-schema-diff>
 - <https://github.com/kristiandupont/schemalint>
+- <https://github.com/supabase-community/postgres-language-server>
 
 ## related blog posts / SE Posts / PG Docs
 
@@ -261,22 +262,20 @@ s/new-rule 'prefer big serial'
 
 ### releasing a new version
 
-1. update the CHANGELOG.md and bump version in the cli `Cargo.toml`, ensure the
-   lock file is updated, and update `package.json` and commit the changes
+1. Update the `CHANGELOG.md`
+
+   Include a description of any fixes / additions. Make sure to include the PR numbers and credit the authors.
+
+2. Run `s/update-version`
 
    ```bash
-   # update version in Cargo.toml files and package.json to 4.5.3
+   # update version in cli/Cargo.toml, package.json, flake.nix to 4.5.3
    s/update-version 4.5.3
    ```
 
-2. create a new release on github - CI will attach the binaries automatically
-3. wait for build artifacts to be attached to release.
-4. login to `npm` and publish new version.
+3. Create a new release on GitHub
 
-   ```bash
-   npm login
-   npm publish
-   ```
+   Use the text and version from the `CHANGELOG.md`
 
 ### algolia
 

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "squawk"
-version = "1.5.5"
+version = "1.6.1"
 authors = ["Steve Dignam <steve@dignam.xyz>"]
 edition = "2018"
 license = "GPL-3.0"

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/cli/README.md

@@ -173,13 +173,13 @@ See the ["GitHub Integration" docs](https://squawkhq.com/docs/github_app) for mo
 Integrate Squawk into Git workflow with [pre-commit](https://pre-commit.com/). Add the following
 to your project's `.pre-commit-config.yaml`:
 
-```
+```yaml
 repos:
   - repo: https://github.com/sbdchd/squawk
     rev: v0.10.0
     hooks:
-     - id: squawk
-       files: path/to/postres/migrations/written/in/sql
+      - id: squawk
+        files: path/to/postgres/migrations/written/in/sql
 ```
 
 Note the `files` parameter as it specifies the location of the files to be linted.
@@ -197,6 +197,7 @@ Note the `files` parameter as it specifies the location of the files to be linte
 - <https://github.com/AdmTal/PostgreSQL-Query-Lock-Explainer>
 - <https://github.com/stripe/pg-schema-diff>
 - <https://github.com/kristiandupont/schemalint>
+- <https://github.com/supabase-community/postgres-language-server>
 
 ## related blog posts / SE Posts / PG Docs
 
@@ -241,22 +242,20 @@ s/new-rule 'prefer big serial'
 
 ### releasing a new version
 
-1. update the CHANGELOG.md and bump version in the cli `Cargo.toml`, ensure the
-   lock file is updated, and update `package.json` and commit the changes
+1. Update the `CHANGELOG.md`
+
+   Include a description of any fixes / additions. Make sure to include the PR numbers and credit the authors.
+
+2. Run `s/update-version`
 
    ```bash
-   # update version in Cargo.toml files and package.json to 4.5.3
+   # update version in cli/Cargo.toml, package.json, flake.nix to 4.5.3
    s/update-version 4.5.3
    ```
 
-2. create a new release on github - CI will attach the binaries automatically
-3. wait for build artifacts to be attached to release.
-4. login to `npm` and publish new version.
+3. Create a new release on GitHub
 
-   ```bash
-   npm login
-   npm publish
-   ```
+   Use the text and version from the `CHANGELOG.md`
 
 ### algolia
 

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/cli/src/reporter.rs

@@ -386,9 +386,19 @@ 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)]
@@ -396,7 +406,8 @@ pub fn pretty_violations(
                 } 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);
+    }
 }

squawk_cli-1.6.1/cli/src/snapshots/squawk__reporter__test_reporter__highlight_column_for_issues.snap

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

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/cli/src/snapshots/squawk__reporter__test_reporter__span_offsets.snap

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

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/linter/src/lib.rs

@@ -9,7 +9,9 @@ extern crate lazy_static;
 
 use crate::errors::CheckSqlError;
 use crate::rules::adding_required_field;
+use crate::rules::ban_alter_domain_with_add_constraint;
 use crate::rules::ban_concurrent_index_creation_in_transaction;
+use crate::rules::ban_create_domain_with_constraint;
 use crate::rules::ban_drop_not_null;
 use crate::rules::prefer_big_int;
 use crate::rules::prefer_identity;
@@ -98,6 +100,15 @@ lazy_static! {
 
         ],
     },
+    SquawkRule {
+        name: RuleViolationKind::BanAlterDomainWithAddConstraint,
+        func: ban_alter_domain_with_add_constraint,
+        messages: vec![
+            ViolationMessage::Note(
+                "Domains with constraints have poor support for online migrations".into()
+            ),
+        ],
+    },
     SquawkRule {
         name: RuleViolationKind::BanCharField,
         func: ban_char_type,
@@ -119,6 +130,15 @@ lazy_static! {
             ),
         ],
     },
+    SquawkRule {
+        name: RuleViolationKind::BanCreateDomainWithConstraint,
+        func: ban_create_domain_with_constraint,
+        messages: vec![
+            ViolationMessage::Note(
+                "Domains with constraints have poor support for online migrations".into()
+            ),
+        ],
+    },
     SquawkRule {
         name: RuleViolationKind::BanDropColumn,
         func: ban_drop_column,

squawk_cli-1.6.1/linter/src/rules/ban_alter_domain_with_add_constraint.rs

@@ -0,0 +1,71 @@
+use crate::{
+    versions::Version,
+    violations::{RuleViolation, RuleViolationKind},
+};
+
+use squawk_parser::ast::{RawStmt, Stmt};
+
+#[must_use]
+pub fn ban_alter_domain_with_add_constraint(
+    tree: &[RawStmt],
+    _pg_version: Option<Version>,
+    _assume_in_transaction: bool,
+) -> Vec<RuleViolation> {
+    let mut errs = vec![];
+    for raw_stmt in tree {
+        match &raw_stmt.stmt {
+            Stmt::AlterDomainStmt(stmt) if stmt.subtype == "C" => {
+                errs.push(RuleViolation::new(
+                    RuleViolationKind::BanAlterDomainWithAddConstraint,
+                    raw_stmt.into(),
+                    None,
+                ));
+            }
+            _ => continue,
+        }
+    }
+    errs
+}
+
+#[cfg(test)]
+mod test_rules {
+    use crate::{
+        check_sql_with_rule,
+        violations::{RuleViolation, RuleViolationKind},
+    };
+
+    use insta::assert_debug_snapshot;
+
+    fn lint_sql(sql: &str) -> Vec<RuleViolation> {
+        check_sql_with_rule(
+            sql,
+            &RuleViolationKind::BanAlterDomainWithAddConstraint,
+            None,
+            false,
+        )
+        .unwrap()
+    }
+
+    #[test]
+    fn ban_alter_domain_without_add_constraint_is_ok() {
+        let sql = r"
+     ALTER DOMAIN domain_name_1 SET DEFAULT 1;
+     ALTER DOMAIN domain_name_2 SET NOT NULL;
+     ALTER DOMAIN domain_name_3 DROP CONSTRAINT other_domain_name;
+     ALTER DOMAIN domain_name_4 RENAME CONSTRAINT constraint_name TO other_constraint_name;
+     ALTER DOMAIN domain_name_5 RENAME TO other_domain_name;
+     ALTER DOMAIN domain_name_6 VALIDATE CONSTRAINT constraint_name;
+     ALTER DOMAIN domain_name_7 OWNER TO you;
+     ALTER DOMAIN domain_name_8 SET SCHEMA foo;
+       ";
+        assert_eq!(lint_sql(sql), vec![]);
+    }
+
+    #[test]
+    fn ban_alter_domain_with_add_constraint_works() {
+        let sql = r"
+     ALTER DOMAIN domain_name ADD CONSTRAINT constraint_name CHECK (value > 0);
+       ";
+        assert_debug_snapshot!(lint_sql(sql));
+    }
+}

squawk_cli-1.6.1/linter/src/rules/ban_create_domain_with_constraint.rs

@@ -0,0 +1,64 @@
+use crate::{
+    versions::Version,
+    violations::{RuleViolation, RuleViolationKind},
+};
+
+use squawk_parser::ast::{RawStmt, Stmt};
+
+#[must_use]
+pub fn ban_create_domain_with_constraint(
+    tree: &[RawStmt],
+    _pg_version: Option<Version>,
+    _assume_in_transaction: bool,
+) -> Vec<RuleViolation> {
+    let mut errs = vec![];
+    for raw_stmt in tree {
+        match &raw_stmt.stmt {
+            Stmt::CreateDomainStmt(stmt) if !stmt.constraints.is_empty() => {
+                errs.push(RuleViolation::new(
+                    RuleViolationKind::BanCreateDomainWithConstraint,
+                    raw_stmt.into(),
+                    None,
+                ));
+            }
+            _ => continue,
+        }
+    }
+    errs
+}
+
+#[cfg(test)]
+mod test_rules {
+    use crate::{
+        check_sql_with_rule,
+        violations::{RuleViolation, RuleViolationKind},
+    };
+    use insta::assert_debug_snapshot;
+
+    fn lint_sql(sql: &str) -> Vec<RuleViolation> {
+        check_sql_with_rule(
+            sql,
+            &RuleViolationKind::BanCreateDomainWithConstraint,
+            None,
+            false,
+        )
+        .unwrap()
+    }
+
+    #[test]
+    fn ban_create_domain_without_constraint_is_ok() {
+        let sql = r"
+    CREATE DOMAIN domain_name_1 AS TEXT;
+    CREATE DOMAIN domain_name_2 AS CHARACTER VARYING;
+      ";
+        assert_eq!(lint_sql(sql), vec![]);
+    }
+
+    #[test]
+    fn ban_create_domain_with_constraint_works() {
+        let sql = r"
+    CREATE DOMAIN domain_name_3 AS NUMERIC(15,5) CHECK (value > 0);
+      ";
+        assert_debug_snapshot!(lint_sql(sql));
+    }
+}

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/linter/src/rules/mod.rs

@@ -52,3 +52,7 @@ pub mod adding_required_field;
 pub use adding_required_field::*;
 pub mod ban_concurrent_index_creation_in_transaction;
 pub use ban_concurrent_index_creation_in_transaction::*;
+pub mod ban_create_domain_with_constraint;
+pub use ban_create_domain_with_constraint::*;
+pub mod ban_alter_domain_with_add_constraint;
+pub use ban_alter_domain_with_add_constraint::*;

squawk_cli-1.6.1/linter/src/rules/snapshots/squawk_linter__rules__ban_alter_domain_with_add_constraint__test_rules__ban_alter_domain_with_add_constraint_works.snap

@@ -0,0 +1,21 @@
+---
+source: linter/src/rules/ban_alter_domain_with_add_constraint.rs
+expression: lint_sql(sql)
+
+---
+[
+    RuleViolation {
+        kind: BanAlterDomainWithAddConstraint,
+        span: Span {
+            start: 0,
+            len: Some(
+                79,
+            ),
+        },
+        messages: [
+            Note(
+                "Domains with constraints have poor support for online migrations",
+            ),
+        ],
+    },
+]

squawk_cli-1.6.1/linter/src/rules/snapshots/squawk_linter__rules__ban_create_domain_with_constraint__test_rules__ban_create_domain_with_constraint_works.snap

@@ -0,0 +1,21 @@
+---
+source: linter/src/rules/ban_create_domain_with_constraint.rs
+expression: lint_sql(sql)
+
+---
+[
+    RuleViolation {
+        kind: BanCreateDomainWithConstraint,
+        span: Span {
+            start: 0,
+            len: Some(
+                67,
+            ),
+        },
+        messages: [
+            Note(
+                "Domains with constraints have poor support for online migrations",
+            ),
+        ],
+    },
+]

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/linter/src/snapshots/squawk_linter__test_rules__rule_names_debug_snap.snap

@@ -1,6 +1,7 @@
 ---
 source: linter/src/lib.rs
 expression: rule_names
+
 ---
 [
     "adding-field-with-default",
@@ -8,8 +9,10 @@ expression: rule_names
     "adding-not-nullable-field",
     "adding-required-field",
     "adding-serial-primary-key-field",
+    "ban-alter-domain-with-add-constraint",
     "ban-char-field",
     "ban-concurrent-index-creation-in-transaction",
+    "ban-create-domain-with-constraint",
     "ban-drop-column",
     "ban-drop-database",
     "ban-drop-not-null",

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/linter/src/snapshots/squawk_linter__test_rules__rule_names_display_snap.snap

@@ -1,14 +1,17 @@
 ---
 source: linter/src/lib.rs
 expression: "rule_names.join(\"\\n\")"
+
 ---
 adding-field-with-default
 adding-foreign-key-constraint
 adding-not-nullable-field
 adding-required-field
 adding-serial-primary-key-field
+ban-alter-domain-with-add-constraint
 ban-char-field
 ban-concurrent-index-creation-in-transaction
+ban-create-domain-with-constraint
 ban-drop-column
 ban-drop-database
 ban-drop-not-null

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/linter/src/violations.rs

@@ -61,6 +61,10 @@ pub enum RuleViolationKind {
     AddingRequiredField,
     #[serde(rename = "ban-concurrent-index-creation-in-transaction")]
     BanConcurrentIndexCreationInTransaction,
+    #[serde(rename = "ban-create-domain-with-constraint")]
+    BanCreateDomainWithConstraint,
+    #[serde(rename = "ban-alter-domain-with-add-constraint")]
+    BanAlterDomainWithAddConstraint,
     // generator::new-rule-above
 }
 

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/parser/src/ast.rs

@@ -429,6 +429,26 @@ pub struct AlterTableStmt {
     pub missing_ok: bool,
 }
 
+#[derive(Debug, Deserialize, Serialize)]
+pub struct CreateDomainStmt {
+    #[serde(rename = "domainname")]
+    pub domain_name: Vec<QualifiedName>,
+    #[serde(rename = "typeName")]
+    pub typename: Value,
+    #[serde(default)]
+    pub constraints: Vec<Value>,
+}
+
+#[derive(Debug, Deserialize, Serialize)]
+pub struct AlterDomainStmt {
+    pub behavior: DropBehavior,
+    pub name: Option<String>,
+    pub subtype: String,
+    #[serde(rename = "typeName")]
+    pub typename: Value,
+    pub def: Option<Value>,
+}
+
 /// Source: <https://github.com/pganalyze/libpg_query/blob/b2790f8140721ff7f047167ecd7d44267b0a3880/src/pg_query_enum_defs.c#L249-L257>
 #[derive(Serialize, Deserialize, PartialEq, Debug)]
 pub enum DropBehavior {
@@ -888,7 +908,7 @@ pub enum Stmt {
     UpdateStmt(Value),
     DeleteStmt(Value),
     CreateSchemaStmt(Value),
-    AlterDomainStmt(Value),
+    AlterDomainStmt(AlterDomainStmt),
     GrantStmt(Value),
     GrantRoleStmt(Value),
     AlterDefaultPrivilegesStmt(Value),
@@ -928,7 +948,7 @@ pub enum Stmt {
     CreateSeqStmt(Value),
     AlterSeqStmt(Value),
     DefineStmt(Value),
-    CreateDomainStmt(Value),
+    CreateDomainStmt(CreateDomainStmt),
     CreateOpClassStmt(Value),
     CreateOpFamilyStmt(Value),
     AlterOpFamilyStmt(Value),

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/parser/src/snapshots/squawk_parser__parse__tests__create_domain_stmt.snap

@@ -1,13 +1,38 @@
 ---
 source: parser/src/parse.rs
 expression: res
+
 ---
 Ok(
     [
         RawStmt {
             stmt: CreateDomainStmt(
-                Object({
-                    "constraints": Array([
+                CreateDomainStmt {
+                    domain_name: [
+                        QualifiedName {
+                            string: PGString {
+                                sval: "us_postal_code",
+                            },
+                        },
+                    ],
+                    typename: Object({
+                        "location": Number(
+                            33,
+                        ),
+                        "names": Array([
+                            Object({
+                                "String": Object({
+                                    "sval": String(
+                                        "text",
+                                    ),
+                                }),
+                            }),
+                        ]),
+                        "typemod": Number(
+                            -1,
+                        ),
+                    }),
+                    constraints: [
                         Object({
                             "Constraint": Object({
                                 "contype": String(
@@ -127,34 +152,8 @@ Ok(
                                 }),
                             }),
                         }),
-                    ]),
-                    "domainname": Array([
-                        Object({
-                            "String": Object({
-                                "sval": String(
-                                    "us_postal_code",
-                                ),
-                            }),
-                        }),
-                    ]),
-                    "typeName": Object({
-                        "location": Number(
-                            33,
-                        ),
-                        "names": Array([
-                            Object({
-                                "String": Object({
-                                    "sval": String(
-                                        "text",
-                                    ),
-                                }),
-                            }),
-                        ]),
-                        "typemod": Number(
-                            -1,
-                        ),
-                    }),
-                }),
+                    ],
+                },
             ),
             stmt_location: 0,
             stmt_len: Some(

{squawk_cli-1.5.5 → squawk_cli-1.6.1}/parser/src/snapshots/squawk_parser__parse__tests__parse_alter_domain_stmt.snap

@@ -1,19 +1,17 @@
 ---
 source: parser/src/parse.rs
 expression: res
+
 ---
 Ok(
     [
         RawStmt {
             stmt: AlterDomainStmt(
-                Object({
-                    "behavior": String(
-                        "DROP_RESTRICT",
-                    ),
-                    "subtype": String(
-                        "O",
-                    ),
-                    "typeName": Array([
+                AlterDomainStmt {
+                    behavior: Restrict,
+                    name: None,
+                    subtype: "O",
+                    typename: Array([
                         Object({
                             "String": Object({
                                 "sval": String(
@@ -22,7 +20,8 @@ Ok(
                             }),
                         }),
                     ]),
-                }),
+                    def: None,
+                },
             ),
             stmt_location: 0,
             stmt_len: Some(