@postgres-language-server/cli 0.0.0 → 0.16.0

package/README.md

@@ -0,0 +1,57 @@
+![Postgres Language Server](/docs/images/pls-github.png)
+
+# Postgres Language Server
+
+A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.
+
+Docs: [pgtools.dev](https://pgtools.dev/)
+
+Install: [instructions](https://pgtools.dev/#installation)
+
+- [CLI releases](https://github.com/supabase-community/postgres-language-server/releases)
+- [VSCode](https://marketplace.visualstudio.com/items?itemName=Supabase.postgrestools)
+- [Neovim](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#postgres_lsp)
+- [Zed](https://github.com/LoamStudios/zed-postgres-language-server)
+
+## Overview
+LSP Demo             |  CLI Demo
+:-------------------------:|:-------------------------:
+![LSP Demo](/docs/images/lsp-demo.gif)  |  ![CLI Demo](/docs/images/cli-demo.png)
+
+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 following features are implemented:
+- Autocompletion
+- Syntax Error Highlighting
+- Type-checking (via `EXPLAIN` error insights)
+- Linter, inspired by [Squawk](https://squawkhq.com)
+
+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)
+- [juleswritescode](https://github.com/juleswritescode)
+
+## Development
+
+### Using Nix
+
+```bash
+nix develop
+docker-compose up -d
+```
+
+### Using Docker
+
+```bash
+docker-compose up -d
+```
+
+## Acknowledgements
+
+A big thanks to the following projects, without which this project wouldn't have been possible:
+
+- [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

package/bin/postgres-language-server

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+const { platform, arch, env } = process;
+
+const PLATFORMS = {
+  win32: {
+    x64: "@postgres-language-server/cli-x86_64-windows-msvc/postgres-language-server.exe",
+    arm64: "@postgres-language-server/cli-aarch64-windows-msvc/postgres-language-server.exe",
+  },
+  darwin: {
+    x64: "@postgres-language-server/cli-x86_64-apple-darwin/postgres-language-server",
+    arm64: "@postgres-language-server/cli-aarch64-apple-darwin/postgres-language-server",
+  },
+  linux: {
+    x64: "@postgres-language-server/cli-x86_64-linux-gnu/postgres-language-server",
+    arm64: "@postgres-language-server/cli-aarch64-linux-gnu/postgres-language-server",
+  },
+  "linux-musl": {
+    x64: "@postgres-language-server/cli-x86_64-linux-musl/postgres-language-server",
+    // no arm64 build for musl
+  },
+};
+
+function isMusl() {
+  let stdout;
+  try {
+    stdout = execSync("ldd --version", {
+      stdio: [
+        "ignore", // stdin
+        "pipe", // stdout – glibc systems print here
+        "pipe", // stderr – musl systems print here
+      ],
+    });
+  } catch (err) {
+    stdout = err.stderr;
+  }
+  if (typeof stdout === 'string' && stdout.indexOf("musl") > -1) {
+    return true;
+  }
+  return false;
+}
+
+function getPlatform() {
+  if (platform === "linux") {
+    return isMusl() ? "linux-musl" : "linux";
+  }
+
+  return platform;
+}
+
+const binPath = env.PGLS_BINARY || PLATFORMS?.[getPlatform()]?.[arch];
+
+if (binPath) {
+  const result = require("child_process").spawnSync(
+    require.resolve(binPath),
+    process.argv.slice(2),
+    {
+      shell: false,
+      stdio: "inherit",
+      env,
+    }
+  );
+
+  if (result.error) {
+    throw result.error;
+  }
+
+  process.exitCode = result.status;
+} else {
+  console.error(
+    "The Postgres Language Server CLI package doesn't ship with prebuilt binaries for your platform yet. Please file an issue in the main repository."
+  );
+  process.exitCode = 1;
+}

package/package.json

@@ -1,11 +1,48 @@
 {
   "name": "@postgres-language-server/cli",
-  "version": "0.0.0",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "0.16.0",
+  "bin": {
+    "postgres-language-server": "bin/postgres-language-server"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/supabase-community/postgres-language-server.git",
+    "directory": "packages/@postgres-language-server/cli"
+  },
+  "author": "Supabase Community",
+  "contributors": [
+    {
+      "name": "Philipp Steinrötter",
+      "url": "https://github.com/psteinroe"
+    },
+    {
+      "name": "Julian Domke",
+      "url": "https://github.com/juleswritescode"
+    }
+  ],
+  "license": "MIT or Apache-2.0",
+  "description": "A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.",
+  "files": [
+    "bin/postgres-language-server",
+    "schema.json",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
   },
-  "author": "",
-  "license": "ISC",
-  "description": ""
-}
+  "publishConfig": {
+    "provenance": true
+  },
+  "optionalDependencies": {
+    "@postgres-language-server/cli-x86_64-windows-msvc": "0.16.0",
+    "@postgres-language-server/cli-aarch64-windows-msvc": "0.16.0",
+    "@postgres-language-server/cli-x86_64-apple-darwin": "0.16.0",
+    "@postgres-language-server/cli-aarch64-apple-darwin": "0.16.0",
+    "@postgres-language-server/cli-x86_64-linux-gnu": "0.16.0",
+    "@postgres-language-server/cli-aarch64-linux-gnu": "0.16.0",
+    "@postgres-language-server/cli-x86_64-linux-musl": "0.16.0"
+  },
+  "scripts": {
+    "test": "bun test"
+  }
+}