fix npm pkg issues

f0rr0 · Nov 19, 2024 · 7ec4a6b · 7ec4a6b
1 parent ecce7b7
commit 7ec4a6b
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -3,16 +3,19 @@
 A WebSocket-TCP proxy that enables PostgreSQL clients to connect to a Postgres database running in the browser. Designed to work with [PGlite](https://pglite.dev/), a lightweight embeddable Postgres that runs in WebAssembly.
 
 This allows you to:
+
 - Use standard PostgreSQL clients (psql, pgAdmin, [Drizzle Studio](https://orm.drizzle.team/drizzle-studio/overview), etc.) to connect to a browser-based database
 - Use tools like `pg_dump` to backup your database
 
 ## How it Works
 
 The proxy creates two servers:
+
 1. A WebSocket server that communicates with the database instance in the browser
 2. A TCP server that accepts standard PostgreSQL client connections
 
 When a PostgreSQL client connects to the TCP server, the proxy:
+
 1. Forwards the client's messages to the browser through WebSocket
 2. Returns the browser's responses back to the client through TCP
 
@@ -32,16 +35,19 @@ bun add pg-browser-proxy
 ### 2. Start the Proxy
 
 Using bunx:
+
 ```sh
 bunx pg-browser-proxy
 ```
 
 To use custom ports:
+
 ```sh
 bunx pg-browser-proxy -t 5433 -w 8080
 ```
 
 See all options:
+
 ```sh
 bunx pg-browser-proxy -h
 ```
@@ -55,7 +61,7 @@ import { PGliteWorker } from "@electric-sql/pglite/worker";
 const db = await PGliteWorker.create(
   new Worker(new URL("./worker", import.meta.url), {
     type: "module",
-  })
+  }),
 );
 
 // Connect to the proxy in development
@@ -81,13 +87,14 @@ pg_dump -h localhost -p 5432 -U postgres > backup.sql
 ```
 
 For tools like Drizzle Studio, configure your connection in your drizzle config:
+
 ```typescript
 export default defineConfig({
   dialect: "postgresql",
   dbCredentials: {
     url: "postgres://localhost:5432",
     ssl: false,
-  }
+  },
 });
 ```
 
@@ -98,4 +105,4 @@ export default defineConfig({
 ## Further Reading
 
 - [pg-gateway](https://github.com/supabase-community/pg-gateway) - Built on top of this project
-- [postgres.new](https://supabase.com/blog/postgres-new) - A blog post by Supabase about running Postgres in the browser
+- [postgres.new](https://supabase.com/blog/postgres-new) - A blog post by Supabase about running Postgres in the browser
diff --git a/examples/pglite-drizzle/src/index.html b/examples/pglite-drizzle/src/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

diff --git a/examples/pglite-prisma/src/index.html b/examples/pglite-prisma/src/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/f0rr0/pg-browser-proxy"
+    "url": "git+https://github.com/f0rr0/pg-browser-proxy.git"
   },
   "funding": {
     "type": "github",

diff --git a/packages/pg-browser-proxy/package.json b/packages/pg-browser-proxy/package.json
@@ -32,7 +32,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/f0rr0/pg-browser-proxy"
+    "url": "git+https://github.com/f0rr0/pg-browser-proxy.git"
   },
   "homepage": "https://github.com/f0rr0/pg-browser-proxy#readme",
   "bugs": {
@@ -73,11 +73,11 @@
       "types": "./dist/browser/index.d.ts"
     },
     "./proxy": {
-      "import": "./bin/src/proxy.js",
-      "types": "./bin/src/proxy.d.ts"
+      "import": "./dist/proxy/proxy.js",
+      "types": "./dist/proxy/proxy.d.ts"
     }
   },
   "bin": {
-    "pg-proxy": "./bin/src/cli/bin.js"
+    "pg-browser-proxy": "bin/bin.js"
   }
 }
diff --git a/packages/pg-browser-proxy/src/cli/help.ts b/packages/pg-browser-proxy/src/cli/help.ts
@@ -13,11 +13,17 @@ const command: GluegunCommand = {
     print.info(`
   ${chalk.bold.blue("🔌 PG Browser Proxy")}
   
-  ${chalk.blue("A WebSocket-TCP proxy that enables PostgreSQL clients to connect to in-browser databases")}
+  ${chalk.blue(
+    "A WebSocket-TCP proxy that enables PostgreSQL clients to connect to in-browser databases",
+  )}
   
   ${chalk.bold("Options:")}
-    -t, --tcp-port <port>    TCP port for PostgreSQL clients ${chalk.dim(`(default: ${DEFAULT_CONFIG.tcpPort})`)}
-    -w, --ws-port <port>     WebSocket port for browser connections ${chalk.dim(`(default: ${DEFAULT_CONFIG.wsPort})`)}
+    -t, --tcp-port <port>    TCP port for PostgreSQL clients ${chalk.dim(
+      `(default: ${DEFAULT_CONFIG.tcpPort})`,
+    )}
+    -w, --ws-port <port>     WebSocket port for browser connections ${chalk.dim(
+      `(default: ${DEFAULT_CONFIG.wsPort})`,
+    )}
     -s, --silent             Suppress all output
     -h, --help               Display help
     -v, --version            Display version