@akshythere/pg-sync 1.0.0 → 1.0.2

package/README.md

@@ -3,7 +3,7 @@
 > PostgreSQL schema introspection that turns your database into useful code and documentation.
 
 <p align="left">
-  <a href="https://www.npmjs.com/package/pg-sync"><img src="https://img.shields.io/npm/v/pg-sync?color=cb3837&logo=npm" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/@akshythere/pg-sync"><img src="https://img.shields.io/npm/v/@akshythere/pg-sync?color=cb3837&logo=npm" alt="npm version"></a>
   <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-5.0%2B-3178C6?logo=typescript&logoColor=white" alt="TypeScript 5.0+"></a>
   <a href="https://www.postgresql.org/"><img src="https://img.shields.io/badge/PostgreSQL-12%2B-336791?logo=postgresql&logoColor=white" alt="PostgreSQL 12+"></a>
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-yellow.svg" alt="MIT license"></a>
@@ -50,7 +50,7 @@ flowchart LR
 ### Use globally
 
 ```bash
-npm install -g pg-sync
+npm install -g @akshythere/pg-sync
 pgs --help
 ```
 
@@ -80,13 +80,14 @@ Example configuration:
 
 ```json
 {
-  "connectionString": "postgresql://postgres:postgres@localhost:5432/mydb",
   "schema": "public",
   "target": "typescript",
   "outputDir": "./src/types"
 }
 ```
 
+Set the connection string in `.env` as `DATABASE_URL=postgresql://user:password@localhost:5432/mydb`.
+
 ### 2. Generate files
 
 ```bash
@@ -97,8 +98,7 @@ Command-line options override values from the config file:
 
 ```bash
 # TypeScript definitions
-pgs generate -u "postgresql://user:pass@localhost:5432/mydb" \
-  -t typescript -o ./src/types
+pgs generate -t typescript -o ./src/types
 
 # Frappe DocTypes
 pgs generate -t frappe -o ./doctypes
@@ -115,7 +115,7 @@ Create `pg-sync.config.json` in the project root, or pass a custom file with `-c
 
 | Property           | Type     | Default          | Description                      |
 | ------------------ | -------- | ---------------- | -------------------------------- |
-| `connectionString` | `string` | Required         | PostgreSQL connection URI        |
+| `connectionString` | `string` | `DATABASE_URL`   | Optional config override         |
 | `schema`           | `string` | `public`         | PostgreSQL schema to inspect     |
 | `target`           | `string` | `typescript`     | `typescript`, `frappe`, or `erd` |
 | `outputDir`        | `string` | Target-dependent | Directory for generated files    |

package/dist/commands/init.js

@@ -7,7 +7,7 @@ export async function runInit() {
     console.log(pc.bold(pc.cyan("\n⚙️  pg-sync Initialization Wizard\n")));
     const connectionString = await input({
         message: "Enter PostgreSQL connection string:",
-        default: "postgresql://postgres:admin@localhost:5432/postgres",
+        default: process.env.DATABASE_URL,
         validate: (val) => val.startsWith("postgresql://") || val.startsWith("postgres://")
             ? true
             : "Invalid PostgreSQL URI format",

package/dist/index.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+import "dotenv/config";
 import { Command } from "commander";
 import pc from "picocolors";
 import { runGenerate } from "./commands/generate.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akshythere/pg-sync",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "PostgreSQL Schema Introspector",
   "main": "dist/index.js",
   "bin": {
@@ -29,6 +29,7 @@
   "dependencies": {
     "@inquirer/prompts": "^8.7.3",
     "commander": "^15.0.0",
+    "dotenv": "^18.0.6",
     "ejs": "^7.0.1",
     "ora": "^9.4.1",
     "pg": "^8.23.1",
@@ -44,4 +45,4 @@
     "typescript": "^7.0.2",
     "vitest": "^5.0.3"
   }
-}
+}