squawk_syntax: refactor identifier out of squawk_linter (#650)

sbdchd · web-flow · commit 39dff3662e52 · 2025-09-16T01:13:26.000Z
also change how we version the crates
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,6 +3,7 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
+version = "2.25.1"
 edition = "2024"
 rust-version = "1.88.0"
 authors = ["Squawk Team & Contributors"]
@@ -53,12 +54,12 @@ xshell = "0.2.7"
 proc-macro2 = "1.0.95"
 
 # local
-squawk_github = { version = "0.0.0", path = "./crates/squawk_github" }
-squawk_lexer = { version = "0.0.0", path = "./crates/squawk_lexer" }
-squawk_parser = { version = "0.0.0", path = "./crates/squawk_parser" }
-squawk_syntax = { version = "0.0.0", path = "./crates/squawk_syntax" }
-squawk_linter = { version = "0.0.0", path = "./crates/squawk_linter" }
-squawk_server = { version = "0.0.0", path = "./crates/squawk_server" }
+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" }
 
 [workspace.lints.clippy]
 collapsible_else_if = "allow"
diff --git a/PLAN.md b/PLAN.md
@@ -120,6 +120,10 @@ sql for benchmarks maybe?
 
   https://github.com/pgvector/pgvector/blob/master/sql/vector.sql
 
+- doomql
+
+  https://github.com/cedardb/DOOMQL
+
 ### CLI
 
 from `deno`
diff --git a/crates/squawk/Cargo.toml b/crates/squawk/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk"
-version = "2.25.1"
+version.workspace = true
 default-run = "squawk"
 
 authors.workspace = true
diff --git a/crates/squawk/src/github.rs b/crates/squawk/src/github.rs
@@ -235,8 +235,10 @@ fn get_summary_comment_body(
         file_summaries.push(summary);
     }
 
-    let summary_notice = Some("⚠️ **Large Report**: This report was summarized due to size constraints. SQL content has been omitted but all violations were analyzed.");
-    
+    let summary_notice = Some(
+        "⚠️ **Large Report**: This report was summarized due to size constraints. SQL content has been omitted but all violations were analyzed.",
+    );
+
     format_comment(
         violations_emoji,
         violations_count,
@@ -293,8 +295,10 @@ fn truncate_sql_if_needed(sql: &str) -> (String, bool) {
     if lines.len() <= MAX_SQL_PREVIEW_LINES {
         (sql.to_string(), false)
     } else {
-        let truncated_lines = lines[..MAX_SQL_PREVIEW_LINES].join("
-");
+        let truncated_lines = lines[..MAX_SQL_PREVIEW_LINES].join(
+            "
+",
+        );
         let remaining_lines = lines.len() - MAX_SQL_PREVIEW_LINES;
         (
             format!(
diff --git a/crates/squawk_github/Cargo.toml b/crates/squawk_github/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk_github"
-version = "0.0.0"
+version.workspace = true
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
diff --git a/crates/squawk_lexer/Cargo.toml b/crates/squawk_lexer/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk_lexer"
-version = "0.0.0"
+version.workspace = true
 description = "TBD"
 
 authors.workspace = true
diff --git a/crates/squawk_linter/Cargo.toml b/crates/squawk_linter/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk_linter"
-version = "0.0.0"
+version.workspace = true
 edition.workspace = true
 rust-version.workspace = true
 authors.workspace = true
diff --git a/crates/squawk_linter/src/lib.rs b/crates/squawk_linter/src/lib.rs
@@ -20,7 +20,6 @@ mod ignore_index;
 mod version;
 mod visitors;
 
-mod identifier;
 mod rules;
 
 #[cfg(test)]
diff --git a/crates/squawk_linter/src/rules/adding_field_with_default.rs b/crates/squawk_linter/src/rules/adding_field_with_default.rs
@@ -1,11 +1,10 @@
 use lazy_static::lazy_static;
 use std::collections::HashSet;
 
-use squawk_syntax::ast;
 use squawk_syntax::ast::AstNode;
 use squawk_syntax::{Parse, SourceFile};
+use squawk_syntax::{ast, identifier::Identifier};
 
-use crate::identifier::Identifier;
 use crate::{Linter, Rule, Version, Violation};
 
 fn is_const_expr(expr: &ast::Expr) -> bool {
diff --git a/crates/squawk_linter/src/rules/ban_char_field.rs b/crates/squawk_linter/src/rules/ban_char_field.rs
@@ -4,10 +4,11 @@ use rowan::TextRange;
 use squawk_syntax::{
     Parse, SourceFile, TokenText,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
 use crate::visitors::check_not_allowed_types;
-use crate::{Edit, Fix, Linter, Rule, Violation, identifier::Identifier};
+use crate::{Edit, Fix, Linter, Rule, Violation};
 
 use lazy_static::lazy_static;
 
diff --git a/crates/squawk_linter/src/rules/constraint_missing_not_valid.rs b/crates/squawk_linter/src/rules/constraint_missing_not_valid.rs
@@ -3,9 +3,10 @@ use std::collections::HashSet;
 use squawk_syntax::{
     Parse, SourceFile,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
-use crate::{Linter, Rule, Violation, identifier::Identifier};
+use crate::{Linter, Rule, Violation};
 
 pub fn tables_created_in_transaction(
     assume_in_transaction: bool,
diff --git a/crates/squawk_linter/src/rules/disallow_unique_constraint.rs b/crates/squawk_linter/src/rules/disallow_unique_constraint.rs
@@ -1,9 +1,10 @@
 use squawk_syntax::{
     Parse, SourceFile,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
-use crate::{Linter, Rule, Violation, identifier::Identifier};
+use crate::{Linter, Rule, Violation};
 
 use super::constraint_missing_not_valid::tables_created_in_transaction;
 
diff --git a/crates/squawk_linter/src/rules/prefer_bigint_over_int.rs b/crates/squawk_linter/src/rules/prefer_bigint_over_int.rs
@@ -1,9 +1,8 @@
 use std::collections::HashSet;
 
 use squawk_syntax::ast::AstNode;
-use squawk_syntax::{Parse, SourceFile, ast};
+use squawk_syntax::{Parse, SourceFile, ast, identifier::Identifier};
 
-use crate::identifier::Identifier;
 use crate::{Edit, Fix, Linter, Rule, Violation};
 
 use crate::visitors::check_not_allowed_types;
diff --git a/crates/squawk_linter/src/rules/prefer_bigint_over_smallint.rs b/crates/squawk_linter/src/rules/prefer_bigint_over_smallint.rs
@@ -1,9 +1,8 @@
 use std::collections::HashSet;
 
 use squawk_syntax::ast::AstNode;
-use squawk_syntax::{Parse, SourceFile, ast};
+use squawk_syntax::{Parse, SourceFile, ast, identifier::Identifier};
 
-use crate::identifier::Identifier;
 use crate::{Edit, Fix, Linter, Rule, Violation};
 
 use crate::visitors::check_not_allowed_types;
diff --git a/crates/squawk_linter/src/rules/prefer_identity.rs b/crates/squawk_linter/src/rules/prefer_identity.rs
@@ -3,9 +3,10 @@ use std::collections::HashSet;
 use squawk_syntax::{
     Parse, SourceFile,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
-use crate::{Edit, Fix, Linter, Rule, Violation, identifier::Identifier};
+use crate::{Edit, Fix, Linter, Rule, Violation};
 
 use lazy_static::lazy_static;
 
diff --git a/crates/squawk_linter/src/rules/prefer_robust_stmts.rs b/crates/squawk_linter/src/rules/prefer_robust_stmts.rs
@@ -3,9 +3,10 @@ use std::collections::HashMap;
 use squawk_syntax::{
     Parse, SourceFile,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
-use crate::{Edit, Fix, Linter, Rule, Violation, identifier::Identifier};
+use crate::{Edit, Fix, Linter, Rule, Violation};
 
 #[derive(PartialEq)]
 enum Constraint {
diff --git a/crates/squawk_linter/src/rules/prefer_text_field.rs b/crates/squawk_linter/src/rules/prefer_text_field.rs
@@ -3,9 +3,10 @@ use std::collections::HashSet;
 use squawk_syntax::{
     Parse, SourceFile,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
-use crate::{Edit, Fix, Linter, Rule, Violation, identifier::Identifier};
+use crate::{Edit, Fix, Linter, Rule, Violation};
 
 use crate::visitors::check_not_allowed_types;
 
diff --git a/crates/squawk_linter/src/rules/prefer_timestamptz.rs b/crates/squawk_linter/src/rules/prefer_timestamptz.rs
@@ -1,10 +1,11 @@
 use squawk_syntax::{
     Parse, SourceFile,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
+use crate::visitors::check_not_allowed_types;
 use crate::{Edit, Fix, Linter, Rule, Violation};
-use crate::{identifier::Identifier, visitors::check_not_allowed_types};
 
 pub fn is_not_allowed_timestamp(ty: &ast::Type) -> bool {
     match ty {
diff --git a/crates/squawk_linter/src/rules/require_concurrent_index_creation.rs b/crates/squawk_linter/src/rules/require_concurrent_index_creation.rs
@@ -1,9 +1,10 @@
 use squawk_syntax::{
     Parse, SourceFile,
     ast::{self, AstNode},
+    identifier::Identifier,
 };
 
-use crate::{Edit, Fix, Linter, Rule, Violation, identifier::Identifier};
+use crate::{Edit, Fix, Linter, Rule, Violation};
 
 use super::constraint_missing_not_valid::tables_created_in_transaction;
 
diff --git a/crates/squawk_linter/src/visitors.rs b/crates/squawk_linter/src/visitors.rs
@@ -1,8 +1,8 @@
 use std::collections::HashSet;
 
-use squawk_syntax::ast;
+use squawk_syntax::{ast, identifier::Identifier};
 
-use crate::{Linter, identifier::Identifier};
+use crate::Linter;
 
 pub(crate) fn is_not_valid_int_type(
     ty: &ast::Type,
diff --git a/crates/squawk_parser/Cargo.toml b/crates/squawk_parser/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk_parser"
-version = "0.0.0"
+version.workspace = true
 description = "TBD"
 
 authors.workspace = true
diff --git a/crates/squawk_server/Cargo.toml b/crates/squawk_server/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk_server"
-version = "0.0.0"
+version.workspace = true
 
 authors.workspace = true
 edition.workspace = true
diff --git a/crates/squawk_syntax/Cargo.toml b/crates/squawk_syntax/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk_syntax"
-version = "0.0.0"
+version.workspace = true
 edition.workspace = true
 rust-version.workspace = true
 authors.workspace = true
diff --git a/crates/squawk_syntax/src/identifier.rs b/crates/squawk_syntax/src/identifier.rs
@@ -2,7 +2,7 @@
 ///
 /// This type handles the casing rules for us to make comparisions easier.
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
-pub(crate) struct Identifier(String);
+pub struct Identifier(String);
 
 impl Identifier {
     // TODO: we need to handle more advanced identifiers like:
diff --git a/crates/squawk_syntax/src/lib.rs b/crates/squawk_syntax/src/lib.rs
@@ -25,6 +25,7 @@
 // DEALINGS IN THE SOFTWARE.
 
 pub mod ast;
+pub mod identifier;
 mod parsing;
 pub mod syntax_error;
 mod syntax_node;
diff --git a/crates/squawk_wasm/Cargo.toml b/crates/squawk_wasm/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk_wasm"
-version = "0.1.0"
+version.workspace = true
 edition.workspace = true
 rust-version.workspace = true
 authors.workspace = true
diff --git a/crates/xtask/Cargo.toml b/crates/xtask/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "xtask"
-version = "0.1.0"
+version.workspace = true
 
 authors.workspace = true
 edition.workspace = true
diff --git a/s/check-version b/s/check-version
@@ -38,7 +38,7 @@ CLI_VERSION_PATTERN = r"version = \"(?P<version>\d+\.\d+\.\d+)\""
 
 
 def find_cli_version() -> str:
-    cargo_toml = squawk_root() / "crates/squawk/Cargo.toml"
+    cargo_toml = squawk_root() / "Cargo.toml"
     for line in cargo_toml.read_text().split("\n"):
         match = re.match(CLI_VERSION_PATTERN, line)
         if match is not None:
diff --git a/s/update-version b/s/update-version
