true-pg 0.2.1 → 0.2.3

package/README.md

@@ -51,13 +51,13 @@ Example config file:
 
 ## Configuration Options
 
-| Option             | Description                                              | Default                       |
-| ------------------ | -------------------------------------------------------- | ----------------------------- |
-| `uri`              | PostgreSQL connection URI                                | Required, or connectionConfig |
-| `connectionConfig` | PostgreSQL connection config object                      | Required, or uri              |
-| `out`              | Output directory for generated files                     | `"models"`                    |
-| `adapters`         | Adapters to use (e.g. `kysely`, `zod`)                   | `"kysely"`                    |
-| `defaultSchema`    | Default schema to use (Kysely schema will be unprefixed) | `"public"`                    |
+| Option          | Description                                              | Default             |
+| --------------- | -------------------------------------------------------- | ------------------- |
+| `uri`           | PostgreSQL connection URI                                | Required, or config |
+| `config`        | Knex connection config object                            | Required, or uri    |
+| `out`           | Output directory for generated files                     | `"models"`          |
+| `adapters`      | Adapters to use (e.g. `kysely`, `zod`)                   | `"kysely"`          |
+| `defaultSchema` | Default schema to use (Kysely schema will be unprefixed) | `"public"`          |
 
 ## Customising Code Generation
 

package/lib/bin.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 import mri from "mri";
-import { existsSync, readFileSync } from "fs";
 import { generate, adapters } from "./index.js";
 const args = process.argv.slice(2);
 const opts = mri(args, {
@@ -15,7 +14,11 @@ const opts = mri(args, {
         A: "all-adapters",
     },
 });
-const help = opts.help || (!opts.config && !opts.uri);
+import { cosmiconfig } from "cosmiconfig";
+const explorer = cosmiconfig("truepg");
+const result = opts.config ? await explorer.load(opts.config) : await explorer.search();
+const config = result?.config ?? {};
+const help = opts.help || (!config && !opts.uri);
 if (help) {
     // if help is triggered unintentionally, it's a user error
     const type = opts.help ? "log" : "error";
@@ -39,17 +42,6 @@ if (help) {
     else
         process.exit(1);
 }
-let configfile = opts.config;
-if (!configfile) {
-    const candidates = [".truepgrc.json", ".config/.truepgrc.json"];
-    for (const candidate of candidates) {
-        if (await existsSync(candidate)) {
-            configfile = candidate;
-            break;
-        }
-    }
-}
-const config = configfile ? JSON.parse(readFileSync(configfile, "utf-8")) : {};
 if (opts["all-adapters"]) {
     opts.adapter = Object.keys(adapters);
     console.log("Enabling all built-in adapters:", opts.adapter);

package/lib/index.d.ts

@@ -1,4 +1,4 @@
 import { type TruePGOpts, type createGenerator } from "./types.ts";
+export { config } from "./types.ts";
 export declare const adapters: Record<string, createGenerator>;
-export * from "./consumer.ts";
 export declare function generate(opts: TruePGOpts, generators?: createGenerator[]): Promise<void>;

package/lib/index.js

@@ -3,13 +3,14 @@ import { rm, mkdir, writeFile } from "fs/promises";
 import { Nodes, allowed_kind_names } from "./types.js";
 import { existsSync } from "fs";
 import { join } from "./util.js";
+export { config } from "./types.js";
+// import { Pool } from "pg";
 import { Kysely } from "./kysely/index.js";
 import { Zod } from "./zod/index.js";
 export const adapters = {
     kysely: Kysely,
     zod: Zod,
 };
-export * from "./consumer.js";
 const filter_function = (func, warnings) => {
     const typesToFilter = [
         "pg_catalog.trigger",
@@ -80,9 +81,11 @@ const multifile = async (generators, schemas, opts) => {
         const schemaDir = `${out}/${schema.name}`;
         // skip functions that cannot be represented in JavaScript
         schema.functions = schema.functions.filter(f => filter_function(f, warnings));
+        let createIndex = false;
         for (const kind of allowed_kind_names) {
             if (schema[kind].length < 1)
                 continue;
+            createIndex = true;
             await mkdir(`${schemaDir}/${kind}`, { recursive: true });
             console.log(" Creating %s:\n", kind);
             for (const [i, item] of schema[kind].entries()) {
@@ -117,6 +120,8 @@ const multifile = async (generators, schemas, opts) => {
             await write(kindIndexFilename, kindIndex);
             console.log('  ✅   Created "%s" %s index: %s\n', schema.name, kind, kindIndexFilename);
         }
+        if (!createIndex)
+            continue;
         const index = join(gens.map(gen => gen.schemaIndex(schema, def_gen)));
         const indexFilename = `${out}/${schema.name}/index.ts`;
         await write(indexFilename, index);
@@ -135,10 +140,22 @@ const multifile = async (generators, schemas, opts) => {
 };
 export async function generate(opts, generators) {
     const out = opts.out || "./models";
-    const conn = opts.uri ?? opts.connectionConfig;
-    if (!conn)
-        throw new Error("Either uri or connectionConfig is required. Add either option to your .truepgrc.json.");
-    const extractor = new Extractor(conn);
+    // let pg;
+    // if (opts.pg) pg = opts.pg;
+    // else if (opts.uri) pg = new Pool({ connectionString: opts.uri });
+    // else if (opts.config) pg = new Pool(opts.config);
+    // else {
+    // 	console.error(
+    // 		"One of these options are required in your config file: pg, uri, config. See documentation for more information.",
+    // 	);
+    // 	process.exit(1);
+    // }
+    const config = opts.uri ?? opts.config;
+    if (!config) {
+        console.error("One of these options are required in your config file: uri, config. See documentation for more information.");
+        process.exit(1);
+    }
+    const extractor = new Extractor(config);
     const schemas = await extractor.extractSchemas();
     generators ??= opts.adapters.map(adapter => {
         const selected = adapters[adapter];

package/lib/types.d.ts

@@ -67,11 +67,12 @@ export declare namespace Nodes {
 export type ConnectionConfig = Exclude<ConstructorParameters<typeof Extractor>[0], string | undefined>;
 export interface TruePGOpts {
     uri?: string;
-    connectionConfig?: ConnectionConfig;
+    config?: ConnectionConfig;
     out: string;
     adapters: string[];
     defaultSchema?: string;
 }
+export declare function config(opts: TruePGOpts): TruePGOpts;
 export interface CreateGeneratorOpts {
     defaultSchema?: string;
     warnings: string[];

package/lib/types.js

@@ -1,3 +1,4 @@
+// import type { ClientConfig, Pool, PoolConfig } from "pg";
 import { dirname, relative } from "node:path";
 import { join } from "./util.js";
 // To be updated when we add support for other kinds
@@ -163,5 +164,8 @@ export var Nodes;
     }
     Nodes.ImportList = ImportList;
 })(Nodes || (Nodes = {}));
+export function config(opts) {
+    return opts;
+}
 /* convenience function to create a generator with type inference */
 export const createGenerator = (generatorCreator) => generatorCreator;

package/lib/zod/index.js

@@ -244,7 +244,7 @@ export const Zod = createGenerator(opts => {
                 }));
                 return `\t/* -- ${schema.name} --*/\n\n` + schema_validators || "\t-- no validators\n\n";
             }));
-            out += "\n}\n\n";
+            out += "\n};\n\n";
             out += schemas.map(s => `export type { ${this.formatSchema(s.name)} };`).join("\n");
             return out;
         },

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "true-pg",
-	"version": "0.2.1",
+	"version": "0.2.3",
 	"type": "module",
 	"module": "lib/index.js",
 	"main": "lib/index.js",
@@ -29,6 +29,7 @@
 		"zod": "^3"
 	},
 	"dependencies": {
+		"cosmiconfig": "^9.0.0",
 		"mri": "^1.2.0",
 		"pg-extract": "^0.0.3"
 	}