@postgres-language-server/backend-jsonrpc 0.0.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -0
- package/package.json +35 -7
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# Postgres Language Server
|
|
4
|
+
|
|
5
|
+
A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.
|
|
6
|
+
|
|
7
|
+
Docs: [pgtools.dev](https://pgtools.dev/)
|
|
8
|
+
|
|
9
|
+
Install: [instructions](https://pgtools.dev/#installation)
|
|
10
|
+
|
|
11
|
+
- [CLI releases](https://github.com/supabase-community/postgres-language-server/releases)
|
|
12
|
+
- [VSCode](https://marketplace.visualstudio.com/items?itemName=Supabase.postgrestools)
|
|
13
|
+
- [Neovim](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#postgres_lsp)
|
|
14
|
+
- [Zed](https://github.com/LoamStudios/zed-postgres-language-server)
|
|
15
|
+
|
|
16
|
+
## Overview
|
|
17
|
+
LSP Demo | CLI Demo
|
|
18
|
+
:-------------------------:|:-------------------------:
|
|
19
|
+
 | 
|
|
20
|
+
|
|
21
|
+
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.
|
|
22
|
+
|
|
23
|
+
The following features are implemented:
|
|
24
|
+
- Autocompletion
|
|
25
|
+
- Syntax Error Highlighting
|
|
26
|
+
- Type-checking (via `EXPLAIN` error insights)
|
|
27
|
+
- Linter, inspired by [Squawk](https://squawkhq.com)
|
|
28
|
+
|
|
29
|
+
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!
|
|
30
|
+
|
|
31
|
+
## Contributors
|
|
32
|
+
|
|
33
|
+
- [psteinroe](https://github.com/psteinroe)
|
|
34
|
+
- [juleswritescode](https://github.com/juleswritescode)
|
|
35
|
+
|
|
36
|
+
## Development
|
|
37
|
+
|
|
38
|
+
### Using Nix
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
nix develop
|
|
42
|
+
docker-compose up -d
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Using Docker
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
docker-compose up -d
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Acknowledgements
|
|
52
|
+
|
|
53
|
+
A big thanks to the following projects, without which this project wouldn't have been possible:
|
|
54
|
+
|
|
55
|
+
- [libpg_query](https://github.com/pganalyze/libpg_query): For extracting the Postgres' parser
|
|
56
|
+
- [Biome](https://github.com/biomejs/biome): For implementing a toolchain infrastructure we could copy from
|
|
57
|
+
- [Squawk](https://github.com/sbdchd/squawk): For the linter inspiration
|
package/package.json
CHANGED
|
@@ -1,11 +1,39 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@postgres-language-server/backend-jsonrpc",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"main": "index.js",
|
|
3
|
+
"version": "0.16.0",
|
|
4
|
+
"main": "dist/index.js",
|
|
5
5
|
"scripts": {
|
|
6
|
-
"test": "
|
|
6
|
+
"test": "bun test",
|
|
7
|
+
"test:ci": "bun build && bun test",
|
|
8
|
+
"build": "bun build ./src/index.ts --outdir ./dist --target node"
|
|
7
9
|
},
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
10
|
+
"files": [
|
|
11
|
+
"dist/",
|
|
12
|
+
"README.md"
|
|
13
|
+
],
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "git+https://github.com/supabase-community/postgres-language-server.git",
|
|
17
|
+
"directory": "packages/@postgres-language-server/backend-jsonrpc"
|
|
18
|
+
},
|
|
19
|
+
"author": "Supabase Community",
|
|
20
|
+
"bugs": "ttps://github.com/supabase-community/postgres-language-server/issues",
|
|
21
|
+
"description": "Bindings to the JSON-RPC Workspace API of the Postgres Language Tools daemon",
|
|
22
|
+
"keywords": [
|
|
23
|
+
"TypeScript",
|
|
24
|
+
"Postgres"
|
|
25
|
+
],
|
|
26
|
+
"license": "MIT",
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"provenance": true
|
|
29
|
+
},
|
|
30
|
+
"optionalDependencies": {
|
|
31
|
+
"@postgres-language-server/cli-x86_64-windows-msvc": "0.16.0",
|
|
32
|
+
"@postgres-language-server/cli-aarch64-windows-msvc": "0.16.0",
|
|
33
|
+
"@postgres-language-server/cli-x86_64-apple-darwin": "0.16.0",
|
|
34
|
+
"@postgres-language-server/cli-aarch64-apple-darwin": "0.16.0",
|
|
35
|
+
"@postgres-language-server/cli-x86_64-linux-gnu": "0.16.0",
|
|
36
|
+
"@postgres-language-server/cli-aarch64-linux-gnu": "0.16.0",
|
|
37
|
+
"@postgres-language-server/cli-x86_64-linux-musl": "0.16.0"
|
|
38
|
+
}
|
|
39
|
+
}
|