Merge branch 'main' into chore/more-renaming

Author: psteinroe

.cursorignore

@@ -0,0 +1,3 @@
+# Add directories or file patterns to ignore during indexing (e.g. foo/ or *.csv)
+libpg_query/
+lib/tree_sitter_sql/tree-sitter-sql/

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Release PG_CLI
+name: Release Binary
 
 on:
   workflow_dispatch:
@@ -61,7 +61,7 @@ jobs:
           DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres
 
       - name: 🛠️ Run Build
-        run: cargo build -p pg_cli --release --target ${{ matrix.config.target }}
+        run: cargo build -p pglt_cli --release --target ${{ matrix.config.target }}
 
       # windows is a special snowflake to, it saves binaries as .exe
       - name: 👦 Name the Binary

Cargo.lock

@@ -2,105 +2,29 @@
 
 # Postgres Language Server
 
-A Language Server for Postgres. Not SQL with flavors, just Postgres.
+A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.
 
-> [!WARNING]
-> This is in active development and is only ready for collaborators. But we are getting there! You can find the current roadmap and opportunities to contribute in https://github.com/supabase-community/postgres_lsp/issues/136.
+## Overview
 
-## Features
+This project provides a toolchain for Postgres development, built on Postgres' own parser `libpg_query` to ensure 100% syntax compatibility. It is built on a Server-Client architecture with a transport-agnostic design. This means all features can be accessed not only through the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), but also through other interfaces like a CLI, HTTP APIs, or a WebAssembly module. The goal is to make all the great Postgres tooling out there as accessible as possible, and to build anything that is missing ourselves.
 
-The [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) is an open protocol between code editors and servers to provide code intelligence tools such as code completion and syntax highlighting. This project implements such a language server for Postgres, significantly enhancing the developer experience within your favorite editor by adding:
+Currently, the following features are implemented:
+- Autocompletion
+- Syntax Error Highlighting
+- Type-checking (via `EXPLAIN` error insights)
+- Linter, inspired by [Squawk](https://squawkhq.com)
 
-- Lint
-- Hover
-- Typechecking
-- Syntax Error Diagnostics
-- Inlay Hints
-- Auto-Completion
-- Code actions such as `Execute the statement under the cursor`, or `Execute the current file`
-- Formatter
-- ... and many more
-
-We plan to support all of the above for SQL and PL/pgSQL function bodies too!
-
-## Motivation
-
-Despite the rising popularity of Postgres, support for the PL/pgSQL in IDEs and editors is limited. While there are some _generic_ SQL Language Servers[^1] offering the Postgres syntax as a "flavor" within the parser, they usually fall short due to the ever-evolving and complex syntax of PostgreSQL. There are a few proprietary IDEs[^2] that work well, but the features are only available within the respective IDE.
-
-This Language Server is designed to support Postgres, and only Postgres. The server uses [libpg_query](https://github.com/pganalyze/libpg_query), both as a git submodule for access to its protobuf file and as the [pg_query](https://crates.io/crates/pg_query/5.0.0) rust crate, therefore leveraging the PostgreSQL source to parse the SQL code reliably. Using Postgres within a Language Server might seem unconventional, but it's the only reliable way of parsing all valid PostgreSQL queries. You can find a longer rationale on why This is the Way™ [here](https://pganalyze.com/blog/parse-postgresql-queries-in-ruby). While libpg_query was built to execute SQL, and not to build a language server, any shortcomings have been successfully mitigated in the `parser` crate. You can read the [commented source code](./crates/parser/src/lib.rs) for more details on the inner workings of the parser.
-
-Once the parser is stable, and a robust and scalable data model is implemented, the language server will not only provide basic features such as semantic highlighting, code completion and syntax error diagnostics, but also serve as the user interface for all the great tooling of the Postgres ecosystem.
-
-## Installation
-
-> [!WARNING]
-> This is not ready for production use. Only install this if you want to help with development.
-
-> [!NOTE]
-> Interested in setting up a release process and client extensions for Neovim and VS Code? Please check out https://github.com/supabase-community/postgres_lsp/issues/136!
-
-### Neovim
-
-Add the postgres_lsp executable to your path, and add the following to your config to use it.
-
-```lua
-local util = require 'lspconfig.util'
-local lspconfig = require 'lspconfig'
-
-require('lspconfig.configs').postgres_lsp = {
-  default_config = {
-    name = 'postgres_lsp',
-    cmd = { 'postgres_lsp' },
-    filetypes = { 'sql' },
-    single_file_support = true,
-    root_dir = util.root_pattern 'root-file.txt',
-  },
-}
-
-lspconfig.postgres_lsp.setup { force_setup = true }
-```
-
-### Building from source
-
-You'll need _nightly_ Cargo, Node, and npm installed.
-
-Install the `libpg_query` submodule by running:
-
-```sh
-git submodule update --init --recursive
-```
-
-If you are using VS Code, you can install both the server and the client extension by running:
-
-```sh
-cargo xtask install
-```
-
-If you're not using VS Code, you can install the server by running:
-
-```sh
-cargo xtask install --server
-```
-
-The server binary will be installed in `.cargo/bin`. Make sure that `.cargo/bin` is in `$PATH`.
-
-### Github CodeSpaces
-
-You can setup your development environment on [CodeSpaces](https://github.com/features/codespaces).
-
-After your codespace boots up, run the following command in the shell to install Rust:
-
-```shell
-curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
-```
-
-Proceed with the rest of the installation as usual.
+Our current focus is on refining and enhancing these core features while building a robust and easily accessible infrastructure. For future plans and opportunities to contribute, please check out the issues and discussions. Any contributions are welcome!
 
 ## Contributors
 
-- [psteinroe](https://github.com/psteinroe) (Maintainer)
+- [psteinroe](https://github.com/psteinroe)
+- [juleswritescode](https://github.com/juleswritescode)
+
+## Acknowledgements
 
-## Footnotes
+A big thanks to the following projects, without which this project wouldn't have been possible:
 
-[^1]: Generic SQL Solutions: [sql-language-server](https://github.com/joe-re/sql-language-server), [pgFormatter](https://github.com/darold/pgFormatter/tree/master), [sql-parser-cst](https://github.com/nene/sql-parser-cst)
-[^2]: Proprietary IDEs: [DataGrip](https://www.jetbrains.com/datagrip/)
+- [libpg_query](https://github.com/pganalyze/libpg_query): For extracting the Postgres' parser
+- [Biome](https://github.com/biomejs/biome): For implementing a toolchain infrastructure we could copy from
+- [Squawk](https://github.com/sbdchd/squawk): For the linter inspiration

README.md

@@ -94,7 +94,7 @@ pub trait Rule: RuleMeta + Sized {
 }
 
 /// Diagnostic object returned by a single analysis rule
-#[derive(Debug, Diagnostic)]
+#[derive(Debug, Diagnostic, PartialEq)]
 pub struct RuleDiagnostic {
     #[category]
     pub(crate) category: &'static Category,
@@ -109,7 +109,7 @@ pub struct RuleDiagnostic {
     pub(crate) rule_advice: RuleAdvice,
 }
 
-#[derive(Debug, Default)]
+#[derive(Debug, Default, PartialEq)]
 /// It contains possible advices to show when printing a diagnostic that belong to the rule
 pub struct RuleAdvice {
     pub(crate) details: Vec<Detail>,
@@ -118,7 +118,7 @@ pub struct RuleAdvice {
     pub(crate) code_suggestion_list: Vec<CodeSuggestionAdvice<MarkupBuf>>,
 }
 
-#[derive(Debug, Default)]
+#[derive(Debug, Default, PartialEq)]
 pub struct SuggestionList {
     pub(crate) message: MarkupBuf,
     pub(crate) list: Vec<MarkupBuf>,
@@ -160,7 +160,7 @@ impl Advices for RuleAdvice {
     }
 }
 
-#[derive(Debug)]
+#[derive(Debug, PartialEq)]
 pub struct Detail {
     pub log_category: LogCategory,
     pub message: MarkupBuf,

crates/pglt_analyse/src/rule.rs

@@ -280,6 +280,20 @@ This will cause the documentation generator to ensure the rule does emit
 exactly one diagnostic for this code, and to include a snapshot for the
 diagnostic in the resulting documentation page.
 
+### Testing the Rule
+
+#### Quick Test
+
+To quickly test your rule, head to the `pglt_analyser/src/lib.rs` file and modify the `debug_test` function.
+
+You should:
+
+- remove the `#[ignore]` macro if present
+- change the content of the `SQL` static `&str` to whatever you need
+- pass your group and rule to the `RuleFilter::Rule(..)`
+
+If you run the test, you'll see any diagnostics your rule created in your console.
+
 ### Code generation
 
 For simplicity, use `just` to run all the commands with:

crates/pglt_analyser/CONTRIBUTING.md

@@ -16,3 +16,7 @@ pglt_analyse   = { workspace = true }
 pglt_console   = { workspace = true }
 pglt_query_ext = { workspace = true }
 serde          = { workspace = true }
+
+[dev-dependencies]
+pglt_diagnostics = { workspace = true }
+termcolor        = { workspace = true }

crates/pglt_analyser/Cargo.toml

@@ -65,3 +65,61 @@ impl<'a> Analyser<'a> {
             .collect::<Vec<_>>()
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use core::slice;
+
+    use pglt_analyse::{AnalyserOptions, AnalysisFilter, RuleFilter};
+    use pglt_console::{
+        fmt::{Formatter, Termcolor},
+        markup, Markup,
+    };
+    use pglt_diagnostics::PrintDiagnostic;
+    use termcolor::NoColor;
+
+    use crate::Analyser;
+
+    #[ignore]
+    #[test]
+    fn debug_test() {
+        fn markup_to_string(markup: Markup) -> String {
+            let mut buffer = Vec::new();
+            let mut write = Termcolor(NoColor::new(&mut buffer));
+            let mut fmt = Formatter::new(&mut write);
+            fmt.write_markup(markup).unwrap();
+
+            String::from_utf8(buffer).unwrap()
+        }
+
+        const SQL: &str = r#"alter table test drop column id;"#;
+        let rule_filter = RuleFilter::Rule("safety", "banDropColumn");
+
+        let filter = AnalysisFilter {
+            enabled_rules: Some(slice::from_ref(&rule_filter)),
+            ..Default::default()
+        };
+
+        let ast = pglt_query_ext::parse(SQL).expect("failed to parse SQL");
+
+        let options = AnalyserOptions::default();
+
+        let analyser = Analyser::new(crate::AnalyserConfig {
+            options: &options,
+            filter,
+        });
+
+        let results = analyser.run(crate::AnalyserContext { root: &ast });
+
+        println!("*******************");
+        for result in &results {
+            let text = markup_to_string(markup! {
+                {PrintDiagnostic::simple(result)}
+            });
+            eprintln!("{}", text);
+        }
+        println!("*******************");
+
+        // assert_eq!(results, vec![]);
+    }
+}

crates/pglt_analyser/src/lib.rs

@@ -12,7 +12,7 @@ declare_lint_rule! {
     ///
     /// ### Invalid
     ///
-    /// ```sql,ignore
+    /// ```sql,expect_diagnostic
     /// alter table test drop column id;
     /// ```
     ///

crates/pglt_analyser/src/lint/safety/ban_drop_column.rs

@@ -12,7 +12,7 @@ declare_lint_rule! {
     ///
     /// ### Invalid
     ///
-    /// ```sql,ignore
+    /// ```sql,expect_diagnostic
     /// alter table users alter column email drop not null;
     /// ```
     pub BanDropNotNull {