@casekit/orm2-cli 0.0.0-20250322230249

package/build/commands/init/options.js

@@ -0,0 +1,12 @@
+export const builder = {
+    force: {
+        type: "boolean",
+        desc: "Overwrite existing files without asking for confirmation",
+        default: false,
+    },
+    directory: {
+        alias: "d",
+        type: "string",
+        desc: "Location to keep your database configuration",
+    },
+};

package/build/commands/init/util/generateConfigFile.d.ts

@@ -0,0 +1 @@
+export declare const generateConfigFile: (directory: string) => string;

package/build/commands/init/util/generateConfigFile.js

@@ -0,0 +1,12 @@
+import { unindent } from "@casekit/unindent";
+export const generateConfigFile = (directory) => unindent `
+    import { orm } from "@casekit/orm2";
+    import type { OrmCLIConfig } from "@casekit/orm2-cli";
+
+    import { models } from "./${directory.replace(/^\.\//, "")}/models";
+
+    export default {
+        db: orm({ models }),
+        directory: "${directory}",
+    } satisfies OrmCLIConfig;
+`;

package/build/commands/init/util/generateDbFile.d.ts

@@ -0,0 +1 @@
+export declare const generateDbFile: () => string;

package/build/commands/init/util/generateDbFile.js

@@ -0,0 +1,61 @@
+import { unindent } from "@casekit/unindent";
+import { usesDevServer } from "#util/usesDevServer.js";
+export const generateDbFile = () => {
+    return usesDevServer()
+        ? unindent `
+            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+
+            import { models } from "./models";
+
+            export type Models = typeof models;
+
+            export type Model<M extends keyof Models> = ModelType<Models, M>;
+
+            export const config: Config<Models> = {
+                models,
+                pool: true,
+            };
+
+            let db: Orm<Models>;
+
+            declare global {
+                // eslint-disable-next-line no-var
+                var __db: Orm<Models>;
+            }
+
+            // we do this because in development we don't want to restart
+            // the server with every change, but we want to make sure we don't
+            // create a new connection to the DB with every change either.
+            if (process.env.NODE_ENV === "production") {
+                db = orm(config);
+                await db.connect();
+            } else {
+                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+                if (!global.__db) {
+                    global.__db = orm(config);
+                    await global.__db.connect();
+                }
+                db = global.__db;
+            }
+
+            export { db };
+        `
+        : unindent `
+            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+
+            import { models } from "./models";
+
+            export type Models = typeof models;
+            export type Model<M extends keyof Models> = ModelType<Models, M>;
+
+            export const config: Config<Models> = {
+                models,
+                pool: true,
+            };
+
+            const db: Orm<Models> = orm(config);
+            await db.connect();
+
+            export { db };
+        `;
+};

package/build/commands/init/util/generateModelsFile.d.ts

@@ -0,0 +1 @@
+export declare const generateModelsFile: () => string;

package/build/commands/init/util/generateModelsFile.js

@@ -0,0 +1,4 @@
+import { unindent } from "@casekit/unindent";
+export const generateModelsFile = () => unindent `
+    export const models = {};
+`;

package/build/commands/init.d.ts

@@ -0,0 +1,28 @@
+export declare const init: {
+    command: string;
+    desc: string;
+    builder: {
+        readonly force: {
+            readonly type: "boolean";
+            readonly desc: "Overwrite existing files without asking for confirmation";
+            readonly default: false;
+        };
+        readonly directory: {
+            readonly alias: "d";
+            readonly type: "string";
+            readonly desc: "Location to keep your database configuration";
+        };
+    };
+    handler: import("../types.js").Handler<{
+        readonly force: {
+            readonly type: "boolean";
+            readonly desc: "Overwrite existing files without asking for confirmation";
+            readonly default: false;
+        };
+        readonly directory: {
+            readonly alias: "d";
+            readonly type: "string";
+            readonly desc: "Location to keep your database configuration";
+        };
+    }>;
+};

package/build/commands/init.js

@@ -0,0 +1,8 @@
+import { handler } from "./init/handler.js";
+import { builder } from "./init/options.js";
+export const init = {
+    command: "init",
+    desc: "Configure your project for use with @casekit/orm2",
+    builder,
+    handler,
+};

package/build/commands/init.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/commands/init.test.js

@@ -0,0 +1,112 @@
+import * as prompts from "@inquirer/prompts";
+import { vol } from "memfs";
+import { describe, expect, test, vi } from "vitest";
+import yargs from "yargs";
+import { unindent } from "@casekit/unindent";
+import { init } from "./init.js";
+describe("init", () => {
+    test("creating config files for a react-router app", async () => {
+        vol.fromJSON({
+            "package.json": JSON.stringify({
+                dependencies: {
+                    "react-router": "^6.0.0",
+                },
+            }),
+        }, "/project");
+        vi.spyOn(prompts, "input").mockResolvedValueOnce("./app/db.server");
+        vi.spyOn(prompts, "confirm").mockResolvedValueOnce(true);
+        await yargs().command(init).parseAsync("init");
+        const dbFile = vol.readFileSync("./app/db.server/db.ts", "utf-8");
+        const modelFile = vol.readFileSync("./app/db.server/models/index.ts", "utf-8");
+        const configFile = vol.readFileSync("./orm.config.ts", "utf-8");
+        expect(dbFile).toEqual(unindent `
+            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+
+            import { models } from "./models";
+
+            export type Models = typeof models;
+
+            export type Model<M extends keyof Models> = ModelType<Models, M>;
+
+            export const config: Config<Models> = {
+                models,
+                pool: true,
+            };
+
+            let db: Orm<Models>;
+
+            declare global {
+                // eslint-disable-next-line no-var
+                var __db: Orm<Models>;
+            }
+
+            // we do this because in development we don't want to restart
+            // the server with every change, but we want to make sure we don't
+            // create a new connection to the DB with every change either.
+            if (process.env.NODE_ENV === "production") {
+                db = orm(config);
+                await db.connect();
+            } else {
+                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+                if (!global.__db) {
+                    global.__db = orm(config);
+                    await global.__db.connect();
+                }
+                db = global.__db;
+            }
+
+            export { db };
+        `);
+        expect(modelFile).toEqual(unindent `
+            export const models = {};
+        `);
+        expect(configFile).toEqual(unindent `
+            import { orm } from "@casekit/orm2";
+            import type { OrmCLIConfig } from "@casekit/orm2-cli";
+
+            import { models } from "./app/db.server/models";
+
+            export default {
+                db: orm({ models }),
+                directory: "./app/db.server",
+            } satisfies OrmCLIConfig;
+        `);
+    });
+    test("optionally overwriting existing files", async () => {
+        vol.fromJSON({
+            "package.json": JSON.stringify({ dependencies: {} }),
+            "app/db.server/models/index.ts": "original",
+            "orm.config.ts": "original",
+            "app/db.server/db.ts": "original",
+        }, "/project");
+        vi.spyOn(prompts, "input").mockResolvedValueOnce("./app/db.server");
+        vi.spyOn(prompts, "confirm")
+            .mockResolvedValueOnce(true)
+            .mockResolvedValueOnce(false)
+            .mockResolvedValueOnce(false);
+        await yargs().command(init).parseAsync("init");
+        const dbFile = vol.readFileSync("./app/db.server/db.ts", "utf-8");
+        const modelFile = vol.readFileSync("./app/db.server/models/index.ts", "utf-8");
+        const configFile = vol.readFileSync("./orm.config.ts", "utf-8");
+        expect(dbFile).toEqual(unindent `
+            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+
+            import { models } from "./models";
+
+            export type Models = typeof models;
+            export type Model<M extends keyof Models> = ModelType<Models, M>;
+
+            export const config: Config<Models> = {
+                models,
+                pool: true,
+            };
+
+            const db: Orm<Models> = orm(config);
+            await db.connect();
+
+            export { db };
+        `);
+        expect(modelFile).toEqual("original");
+        expect(configFile).toEqual("original");
+    });
+});

package/build/index.d.ts

@@ -0,0 +1 @@
+export { OrmCLIConfig } from "./types.js";

package/build/index.js

@@ -0,0 +1 @@
+export {};

package/build/options.d.ts

@@ -0,0 +1,12 @@
+export declare const globalOptions: {
+    readonly config: {
+        readonly type: "string";
+        readonly alias: "c";
+        readonly describe: "Path to the orm CLIs configuration file";
+        readonly default: "orm.config.ts";
+    };
+    readonly force: {
+        readonly type: "boolean";
+        readonly desc: "Skip all prompts, use defaults, and overwrite existing files without asking for confirmation";
+    };
+};

package/build/options.js

@@ -0,0 +1,12 @@
+export const globalOptions = {
+    config: {
+        type: "string",
+        alias: "c",
+        describe: "Path to the orm CLIs configuration file",
+        default: "orm.config.ts",
+    },
+    force: {
+        type: "boolean",
+        desc: "Skip all prompts, use defaults, and overwrite existing files without asking for confirmation",
+    },
+};

package/build/test/setup.d.ts

@@ -0,0 +1 @@
+export {};

package/build/test/setup.js

@@ -0,0 +1,31 @@
+import { vol } from "memfs";
+import pg from "pg";
+import { register } from "tsx/esm/api";
+import { afterAll, afterEach, beforeAll, beforeEach, vi } from "vitest";
+import * as loadConfig from "#util/loadConfig.js";
+vi.mock("fs");
+vi.mock("prettier");
+vi.mock("@inquirer/prompts");
+let unregister;
+beforeAll(async () => {
+    const client = new pg.Client();
+    await client.connect();
+    await client.query("DROP SCHEMA IF EXISTS orm_cli_test CASCADE");
+    unregister = register();
+});
+afterAll(async () => {
+    await unregister();
+});
+beforeEach(async () => {
+    const path = "./orm.config.ts";
+    const { default: config } = await import(path);
+    vi.spyOn(loadConfig, "loadConfig").mockResolvedValue(config);
+    const originalFs = await vi.importActual("fs");
+    const ormConfig = originalFs.readFileSync("./src/test/orm.config.ts", "utf8");
+    const prettierConfig = originalFs.readFileSync("../../.prettierrc.json", "utf8");
+    vol.fromJSON({ "orm.config.ts": ormConfig, ".prettierrc.json": prettierConfig }, "/project");
+    vi.spyOn(process, "cwd").mockReturnValue("/project");
+});
+afterEach(() => {
+    vol.reset();
+});

package/build/types.d.ts

@@ -0,0 +1,19 @@
+import { ConnectionConfig } from "pg";
+import { ArgumentsCamelCase, InferredOptionTypes, Options } from "yargs";
+import { ZodSchema } from "zod";
+import { ModelDefinition, Orm } from "@casekit/orm2";
+import { globalOptions } from "#options.js";
+export interface OrmCLIConfig {
+    db: Orm;
+    directory: string;
+    generate?: {
+        templates?: Record<string, ModelDefinition>;
+        defaultSchemas?: Record<string, ZodSchema>;
+    };
+    migrate?: {
+        connection?: ConnectionConfig;
+    };
+}
+export type Builder = Record<string, Options>;
+export type CommandOptions<T extends Builder = Record<string, never>> = ArgumentsCamelCase<InferredOptionTypes<T & typeof globalOptions>>;
+export type Handler<T extends Builder = Record<string, never>> = (opts: ArgumentsCamelCase<InferredOptionTypes<T & typeof globalOptions>>) => void | Promise<void>;

package/build/types.js

@@ -0,0 +1 @@
+export {};

package/build/util/createOrOverwriteFile.d.ts

@@ -0,0 +1 @@
+export declare const createOrOverwriteFile: (filePath: string, content: string, force?: boolean) => Promise<void>;

package/build/util/createOrOverwriteFile.js

@@ -0,0 +1,17 @@
+import { confirm } from "@inquirer/prompts";
+import fs from "fs";
+import path from "path";
+export const createOrOverwriteFile = async (filePath, content, force) => {
+    const fullPath = path.join(process.cwd(), filePath);
+    if (fs.existsSync(fullPath) && !force) {
+        const overwrite = await confirm({
+            message: `${filePath} already exists - overwrite it?`,
+            default: false,
+        });
+        if (!overwrite)
+            return;
+    }
+    fs.mkdirSync(path.dirname(fullPath), { recursive: true });
+    fs.writeFileSync(fullPath, content);
+    console.log(`- Created ${filePath}`);
+};

package/build/util/loadConfig.d.ts

@@ -0,0 +1,3 @@
+import { globalOptions } from "#options.js";
+import { CommandOptions, OrmCLIConfig } from "#types.js";
+export declare const loadConfig: (options: CommandOptions<typeof globalOptions>) => Promise<OrmCLIConfig>;

package/build/util/loadConfig.js

@@ -0,0 +1,14 @@
+import path from "path";
+import { register } from "tsx/esm/api";
+export const loadConfig = async (options) => {
+    try {
+        const unregister = register();
+        const { default: config } = await import(path.join(process.cwd(), options.config));
+        await unregister();
+        return "default" in config ? config.default : config;
+    }
+    catch (e) {
+        console.error(e instanceof Error ? e.message : e);
+        process.exit(1);
+    }
+};

package/build/util/prettify.d.ts

@@ -0,0 +1 @@
+export declare const prettify: (path: string, content: string) => Promise<string>;

package/build/util/prettify.js

@@ -0,0 +1,8 @@
+import * as prettier from "prettier";
+export const prettify = async (path, content) => {
+    const prettierOptions = await prettier.resolveConfig(path);
+    return await prettier.format(content, {
+        ...prettierOptions,
+        parser: "typescript",
+    });
+};

package/build/util/usesDevServer.d.ts

@@ -0,0 +1 @@
+export declare const usesDevServer: () => boolean;

package/build/util/usesDevServer.js

@@ -0,0 +1,10 @@
+import fs from "fs";
+export const usesDevServer = () => {
+    try {
+        const manifest = JSON.parse(fs.readFileSync("./package.json", "utf-8"));
+        return !!Object.keys(manifest.dependencies).find((dep) => /(^react-router$|^@remix-run|^next$)/.test(dep));
+    }
+    catch {
+        return false;
+    }
+};

package/build/util/usesDevServer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/util/usesDevServer.test.js

@@ -0,0 +1,54 @@
+import { vol } from "memfs";
+import { describe, expect, test } from "vitest";
+import { usesDevServer } from "./usesDevServer.js";
+describe("usesDevServer", () => {
+    test("returns true when package.json has react-router dependency", () => {
+        vol.fromJSON({
+            "package.json": JSON.stringify({
+                dependencies: {
+                    "react-router": "^6.0.0",
+                },
+            }),
+        }, "/project");
+        expect(usesDevServer()).toBe(true);
+    });
+    test("returns true when package.json has @remix-run dependency", () => {
+        vol.fromJSON({
+            "package.json": JSON.stringify({
+                dependencies: {
+                    "@remix-run/react": "^1.0.0",
+                },
+            }),
+        }, "/project");
+        expect(usesDevServer()).toBe(true);
+    });
+    test("returns true when package.json has next.js dependency", () => {
+        vol.fromJSON({
+            "package.json": JSON.stringify({
+                dependencies: {
+                    next: "^12.0.0",
+                },
+            }),
+        }, "/project");
+        expect(usesDevServer()).toBe(true);
+    });
+    test("returns false when package.json has no next, remix, or react-router dependencies", () => {
+        vol.fromJSON({
+            "package.json": JSON.stringify({
+                dependencies: {
+                    lodash: "^4.0.0",
+                },
+            }),
+        }, "/project");
+        expect(usesDevServer()).toBe(false);
+    });
+    test("returns false when package.json is missing", () => {
+        expect(usesDevServer()).toBe(false);
+    });
+    test("returns false when package.json is invalid JSON", () => {
+        vol.fromJSON({
+            "package.json": "invalid json",
+        }, "/project");
+        expect(usesDevServer()).toBe(false);
+    });
+});

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@casekit/orm2-cli",
+  "description": "",
+  "version": "0.0.0-20250322230249",
+  "author": "",
+  "bin": {
+    "orm": "./build/cli.js"
+  },
+  "dependencies": {
+    "@casekit/unindent": "^1.0.5",
+    "@inquirer/prompts": "^7.4.0",
+    "@inquirer/testing": "^2.1.45",
+    "byline": "^5.0.0",
+    "camelcase": "^8.0.0",
+    "es-toolkit": "^1.33.0",
+    "jscodeshift": "^17.2.0",
+    "tsx": "^4.19.3",
+    "yargs": "^17.7.2",
+    "@casekit/orm2": "0.0.0-20250322230249",
+    "@casekit/toolbox": "0.0.0-20250322230249",
+    "@casekit/sql": "0.0.0-20250322230249",
+    "@casekit/orm2-migrate": "0.0.0-20250322230249"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
+    "@types/byline": "^4.2.36",
+    "@types/jscodeshift": "^0.12.0",
+    "@types/node": "^22.13.11",
+    "@types/pg": "^8.11.11",
+    "@types/yargs": "^17.0.33",
+    "@vitest/coverage-v8": "^3.0.9",
+    "dotenv": "^16.4.7",
+    "memfs": "^4.17.0",
+    "prettier": "^3.5.3",
+    "prettier-plugin-svelte": "^3.3.3",
+    "typescript": "^5.8.2",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.0.9",
+    "zod": "^3.24.2",
+    "@casekit/tsconfig": "0.0.0-20250322230249",
+    "@casekit/prettier-config": "0.0.0-20250322230249",
+    "@casekit/orm2-fixtures": "0.0.0-20250322230249"
+  },
+  "exports": {
+    ".": "./build/index.js"
+  },
+  "files": [
+    "/build"
+  ],
+  "imports": {
+    "#*": "./build/*"
+  },
+  "keywords": [],
+  "license": "ISC",
+  "main": "index.js",
+  "peerDependencies": {
+    "pg": "^8.13.1"
+  },
+  "prettier": "@casekit/prettier-config",
+  "type": "module",
+  "scripts": {
+    "build": "rm -rf ./build && tsc",
+    "db:create": "tsx src/cli.ts db drop && tsx src/cli.ts db push",
+    "format:check": "prettier --check .",
+    "format": "prettier --write .",
+    "lint": "eslint src --max-warnings 0",
+    "test": "vitest --run --typecheck --coverage",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}