drizzle-docs-generator 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryuya Ikeda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.ja.md

@@ -0,0 +1,89 @@
+# drizzle-docs-generator
+
+[![npm version](https://badge.fury.io/js/drizzle-docs-generator.svg)](https://www.npmjs.com/package/drizzle-docs-generator)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Drizzle ORM スキーマから DBML を生成する CLI。JSDoc コメントを Note 句として出力できる。
+
+[English README](./README.md)
+
+## インストール
+
+```bash
+npm install -g drizzle-docs-generator
+# or
+pnpm add -g drizzle-docs-generator
+```
+
+## 使い方
+
+```bash
+# 基本
+drizzle-docs generate ./src/db/schema.ts -d postgresql
+
+# ファイル出力
+drizzle-docs generate ./src/db/schema.ts -d postgresql -o schema.dbml
+
+# relations() を使う
+drizzle-docs generate ./src/db/schema.ts -d postgresql -r
+
+# watch モード
+drizzle-docs generate ./src/db/schema.ts -d postgresql -w
+```
+
+### オプション
+
+| オプション                | 説明                                               |
+| ------------------------- | -------------------------------------------------- |
+| `-o, --output <file>`     | 出力ファイルパス                                   |
+| `-d, --dialect <dialect>` | DB 種別: `postgresql` (default), `mysql`, `sqlite` |
+| `-r, --relational`        | relations() 定義からリファレンスを生成             |
+| `-w, --watch`             | ファイル変更時に自動再生成                         |
+
+## 例
+
+```typescript
+/** ユーザーテーブル */
+export const users = pgTable("users", {
+  /** ユーザーID */
+  id: serial("id").primaryKey(),
+  /** ユーザー名 */
+  name: text("name").notNull(),
+});
+```
+
+↓
+
+```dbml
+Table users {
+  id serial [pk, increment, note: 'ユーザーID']
+  name text [not null, note: 'ユーザー名']
+
+  Note: 'ユーザーテーブル'
+}
+```
+
+## API
+
+```typescript
+import { pgGenerate } from "drizzle-docs-generator";
+import * as schema from "./schema";
+
+const dbml = pgGenerate({
+  schema,
+  source: "./schema.ts",
+  relational: false,
+  out: "./output.dbml", // optional
+});
+```
+
+`mysqlGenerate`, `sqliteGenerate` も同様。
+
+## 動作環境
+
+- Node.js >= 24
+- Drizzle ORM v1 beta (1.0.0-beta.10+)
+
+## License
+
+MIT

package/README.md

@@ -0,0 +1,89 @@
+# drizzle-docs-generator
+
+[![npm version](https://badge.fury.io/js/drizzle-docs-generator.svg)](https://www.npmjs.com/package/drizzle-docs-generator)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+CLI tool to generate DBML from Drizzle ORM schemas. Extracts JSDoc comments and outputs them as Note clauses.
+
+[日本語版READMEはこちら](./README.ja.md)
+
+## Install
+
+```bash
+npm install -g drizzle-docs-generator
+# or
+pnpm add -g drizzle-docs-generator
+```
+
+## Usage
+
+```bash
+# Basic
+drizzle-docs generate ./src/db/schema.ts -d postgresql
+
+# Output to file
+drizzle-docs generate ./src/db/schema.ts -d postgresql -o schema.dbml
+
+# Use relations() definitions
+drizzle-docs generate ./src/db/schema.ts -d postgresql -r
+
+# Watch mode
+drizzle-docs generate ./src/db/schema.ts -d postgresql -w
+```
+
+### Options
+
+| Option                    | Description                                         |
+| ------------------------- | --------------------------------------------------- |
+| `-o, --output <file>`     | Output file path                                    |
+| `-d, --dialect <dialect>` | Database: `postgresql` (default), `mysql`, `sqlite` |
+| `-r, --relational`        | Generate refs from relations() definitions          |
+| `-w, --watch`             | Regenerate on file changes                          |
+
+## Example
+
+```typescript
+/** Users table */
+export const users = pgTable("users", {
+  /** User ID */
+  id: serial("id").primaryKey(),
+  /** User name */
+  name: text("name").notNull(),
+});
+```
+
+↓
+
+```dbml
+Table users {
+  id serial [pk, increment, note: 'User ID']
+  name text [not null, note: 'User name']
+
+  Note: 'Users table'
+}
+```
+
+## API
+
+```typescript
+import { pgGenerate } from "drizzle-docs-generator";
+import * as schema from "./schema";
+
+const dbml = pgGenerate({
+  schema,
+  source: "./schema.ts",
+  relational: false,
+  out: "./output.dbml", // optional
+});
+```
+
+`mysqlGenerate`, `sqliteGenerate` are also available.
+
+## Requirements
+
+- Node.js >= 24
+- Drizzle ORM v1 beta (1.0.0-beta.10+)
+
+## License
+
+MIT

package/dist/cli/index.d.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+/**
+ * CLI for drizzle-docs-generator
+ *
+ * Generates DBML files from Drizzle ORM schema definitions.
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";AAEA;;;;GAIG"}

package/dist/cli/index.js

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+import { Command as m } from "commander";
+import { readFileSync as u, existsSync as f, watch as d } from "node:fs";
+import { join as g, resolve as i } from "node:path";
+import { pathToFileURL as p } from "node:url";
+import { pgGenerate as h } from "../generator/pg.js";
+import { mysqlGenerate as w } from "../generator/mysql.js";
+import { sqliteGenerate as y } from "../generator/sqlite.js";
+import "drizzle-orm";
+import "drizzle-orm/pg-core";
+import "drizzle-orm/mysql-core";
+import "drizzle-orm/sqlite-core";
+import "typescript";
+const c = new m(), q = g(import.meta.dirname, "../../package.json"), s = JSON.parse(u(q, "utf-8"));
+c.name("drizzle-docs").description(s.description).version(s.version);
+function D(o) {
+  switch (o) {
+    case "mysql":
+      return w;
+    case "sqlite":
+      return y;
+    default:
+      return h;
+  }
+}
+async function l(o, e) {
+  const r = p(o).href, t = e.watch ? `?t=${Date.now()}` : "", n = await import(r + t);
+  return D(e.dialect)({
+    schema: n,
+    out: e.output,
+    relational: e.relational,
+    source: o
+  });
+}
+async function $(o, e) {
+  const r = i(process.cwd(), o);
+  f(r) || (console.error(`Error: Schema file not found: ${r}`), process.exit(1));
+  try {
+    const t = await l(r, e);
+    !e.output && t ? console.log(t) : e.output && console.log(`DBML generated: ${e.output}`);
+  } catch (t) {
+    t instanceof Error ? console.error(`Error generating DBML: ${t.message}`) : console.error("Error generating DBML:", t), process.exit(1);
+  }
+}
+function b(o, e) {
+  const r = i(process.cwd(), o);
+  console.log(`Watching for changes: ${r}`);
+  let t = null;
+  d(r, async (n) => {
+    n === "change" && (t && clearTimeout(t), t = setTimeout(async () => {
+      console.log(`
+File changed, regenerating...`);
+      try {
+        const a = await l(r, e);
+        !e.output && a ? console.log(a) : e.output && console.log(`DBML regenerated: ${e.output}`);
+      } catch (a) {
+        a instanceof Error ? console.error(`Error: ${a.message}`) : console.error("Error:", a);
+      }
+    }, 100));
+  });
+}
+c.command("generate").description("Generate DBML from Drizzle schema files").argument("<schema>", "Path to Drizzle schema file").option("-o, --output <file>", "Output file path").option("-d, --dialect <dialect>", "Database dialect (postgresql, mysql, sqlite)", "postgresql").option("-r, --relational", "Use relations() definitions instead of foreign keys").option("-w, --watch", "Watch for file changes and regenerate").action(async (o, e) => {
+  const r = ["postgresql", "mysql", "sqlite"];
+  r.includes(e.dialect) || (console.error(
+    `Error: Invalid dialect "${e.dialect}". Valid options: ${r.join(", ")}`
+  ), process.exit(1)), await $(o, e), e.watch && b(o, e);
+});
+c.parse();
+//# sourceMappingURL=index.js.map

package/dist/cli/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/cli/index.ts"],"sourcesContent":["#!/usr/bin/env node\n\n/**\n * CLI for drizzle-docs-generator\n *\n * Generates DBML files from Drizzle ORM schema definitions.\n */\n\nimport { Command } from \"commander\";\nimport { existsSync, readFileSync, watch } from \"node:fs\";\nimport { join, resolve } from \"node:path\";\nimport { pathToFileURL } from \"node:url\";\nimport { pgGenerate, mysqlGenerate, sqliteGenerate } from \"../generator/index\";\n\nconst program = new Command();\n\n// Use import.meta.dirname (Node 20.11+) to resolve package.json\n// This works correctly even after bundling\nconst packageJsonPath = join(import.meta.dirname, \"../../package.json\");\nconst packageJson = JSON.parse(readFileSync(packageJsonPath, \"utf-8\")) as {\n  version: string;\n  description: string;\n};\n\nprogram.name(\"drizzle-docs\").description(packageJson.description).version(packageJson.version);\n\ntype Dialect = \"postgresql\" | \"mysql\" | \"sqlite\";\n\ninterface GenerateCommandOptions {\n  output?: string;\n  dialect: Dialect;\n  relational?: boolean;\n  watch?: boolean;\n}\n\n/**\n * Get the generate function based on dialect\n */\nfunction getGenerator(dialect: Dialect) {\n  switch (dialect) {\n    case \"mysql\":\n      return mysqlGenerate;\n    case \"sqlite\":\n      return sqliteGenerate;\n    case \"postgresql\":\n    default:\n      return pgGenerate;\n  }\n}\n\n/**\n * Generate DBML from a schema file\n */\nasync function generateDbml(\n  schemaPath: string,\n  options: GenerateCommandOptions,\n): Promise<string | undefined> {\n  // Use file URL for dynamic import (required for ESM)\n  const schemaUrl = pathToFileURL(schemaPath).href;\n\n  // Dynamic import with cache busting for watch mode\n  const cacheBuster = options.watch ? `?t=${Date.now()}` : \"\";\n  const schemaModule = (await import(schemaUrl + cacheBuster)) as Record<string, unknown>;\n\n  const generate = getGenerator(options.dialect);\n\n  const dbml = generate({\n    schema: schemaModule,\n    out: options.output,\n    relational: options.relational,\n    source: schemaPath,\n  });\n\n  return dbml;\n}\n\n/**\n * Run the generate command\n */\nasync function runGenerate(schema: string, options: GenerateCommandOptions): Promise<void> {\n  const schemaPath = resolve(process.cwd(), schema);\n\n  // Check if file exists\n  if (!existsSync(schemaPath)) {\n    console.error(`Error: Schema file not found: ${schemaPath}`);\n    process.exit(1);\n  }\n\n  try {\n    const dbml = await generateDbml(schemaPath, options);\n\n    if (!options.output && dbml) {\n      console.log(dbml);\n    } else if (options.output) {\n      console.log(`DBML generated: ${options.output}`);\n    }\n  } catch (error) {\n    if (error instanceof Error) {\n      console.error(`Error generating DBML: ${error.message}`);\n    } else {\n      console.error(\"Error generating DBML:\", error);\n    }\n    process.exit(1);\n  }\n}\n\n/**\n * Watch mode: regenerate DBML on file changes\n */\nfunction watchSchema(schema: string, options: GenerateCommandOptions): void {\n  const schemaPath = resolve(process.cwd(), schema);\n\n  console.log(`Watching for changes: ${schemaPath}`);\n\n  let debounceTimer: NodeJS.Timeout | null = null;\n\n  watch(schemaPath, async (eventType) => {\n    if (eventType === \"change\") {\n      // Debounce to avoid multiple triggers\n      if (debounceTimer) {\n        clearTimeout(debounceTimer);\n      }\n\n      debounceTimer = setTimeout(async () => {\n        console.log(\"\\nFile changed, regenerating...\");\n        try {\n          const dbml = await generateDbml(schemaPath, options);\n\n          if (!options.output && dbml) {\n            console.log(dbml);\n          } else if (options.output) {\n            console.log(`DBML regenerated: ${options.output}`);\n          }\n        } catch (error) {\n          if (error instanceof Error) {\n            console.error(`Error: ${error.message}`);\n          } else {\n            console.error(\"Error:\", error);\n          }\n        }\n      }, 100);\n    }\n  });\n}\n\nprogram\n  .command(\"generate\")\n  .description(\"Generate DBML from Drizzle schema files\")\n  .argument(\"<schema>\", \"Path to Drizzle schema file\")\n  .option(\"-o, --output <file>\", \"Output file path\")\n  .option(\"-d, --dialect <dialect>\", \"Database dialect (postgresql, mysql, sqlite)\", \"postgresql\")\n  .option(\"-r, --relational\", \"Use relations() definitions instead of foreign keys\")\n  .option(\"-w, --watch\", \"Watch for file changes and regenerate\")\n  .action(async (schema: string, options: GenerateCommandOptions) => {\n    // Validate dialect\n    const validDialects: Dialect[] = [\"postgresql\", \"mysql\", \"sqlite\"];\n    if (!validDialects.includes(options.dialect)) {\n      console.error(\n        `Error: Invalid dialect \"${options.dialect}\". Valid options: ${validDialects.join(\", \")}`,\n      );\n      process.exit(1);\n    }\n\n    // Initial generation\n    await runGenerate(schema, options);\n\n    // Start watch mode if requested\n    if (options.watch) {\n      watchSchema(schema, options);\n    }\n  });\n\nprogram.parse();\n"],"names":["program","Command","packageJsonPath","join","packageJson","readFileSync","getGenerator","dialect","mysqlGenerate","sqliteGenerate","pgGenerate","generateDbml","schemaPath","options","schemaUrl","pathToFileURL","cacheBuster","schemaModule","runGenerate","schema","resolve","existsSync","dbml","error","watchSchema","debounceTimer","watch","eventType","validDialects"],"mappings":";;;;;;;;;;;;;AAcA,MAAMA,IAAU,IAAIC,EAAA,GAIdC,IAAkBC,EAAK,YAAY,SAAS,oBAAoB,GAChEC,IAAc,KAAK,MAAMC,EAAaH,GAAiB,OAAO,CAAC;AAKrEF,EAAQ,KAAK,cAAc,EAAE,YAAYI,EAAY,WAAW,EAAE,QAAQA,EAAY,OAAO;AAc7F,SAASE,EAAaC,GAAkB;AACtC,UAAQA,GAAA;AAAA,IACN,KAAK;AACH,aAAOC;AAAA,IACT,KAAK;AACH,aAAOC;AAAA,IAET;AACE,aAAOC;AAAA,EAAA;AAEb;AAKA,eAAeC,EACbC,GACAC,GAC6B;AAE7B,QAAMC,IAAYC,EAAcH,CAAU,EAAE,MAGtCI,IAAcH,EAAQ,QAAQ,MAAM,KAAK,KAAK,KAAK,IACnDI,IAAgB,MAAM,OAAOH,IAAYE;AAW/C,SATiBV,EAAaO,EAAQ,OAAO,EAEvB;AAAA,IACpB,QAAQI;AAAA,IACR,KAAKJ,EAAQ;AAAA,IACb,YAAYA,EAAQ;AAAA,IACpB,QAAQD;AAAA,EAAA,CACT;AAGH;AAKA,eAAeM,EAAYC,GAAgBN,GAAgD;AACzF,QAAMD,IAAaQ,EAAQ,QAAQ,IAAA,GAAOD,CAAM;AAGhD,EAAKE,EAAWT,CAAU,MACxB,QAAQ,MAAM,iCAAiCA,CAAU,EAAE,GAC3D,QAAQ,KAAK,CAAC;AAGhB,MAAI;AACF,UAAMU,IAAO,MAAMX,EAAaC,GAAYC,CAAO;AAEnD,IAAI,CAACA,EAAQ,UAAUS,IACrB,QAAQ,IAAIA,CAAI,IACPT,EAAQ,UACjB,QAAQ,IAAI,mBAAmBA,EAAQ,MAAM,EAAE;AAAA,EAEnD,SAASU,GAAO;AACd,IAAIA,aAAiB,QACnB,QAAQ,MAAM,0BAA0BA,EAAM,OAAO,EAAE,IAEvD,QAAQ,MAAM,0BAA0BA,CAAK,GAE/C,QAAQ,KAAK,CAAC;AAAA,EAChB;AACF;AAKA,SAASC,EAAYL,GAAgBN,GAAuC;AAC1E,QAAMD,IAAaQ,EAAQ,QAAQ,IAAA,GAAOD,CAAM;AAEhD,UAAQ,IAAI,yBAAyBP,CAAU,EAAE;AAEjD,MAAIa,IAAuC;AAE3C,EAAAC,EAAMd,GAAY,OAAOe,MAAc;AACrC,IAAIA,MAAc,aAEZF,KACF,aAAaA,CAAa,GAG5BA,IAAgB,WAAW,YAAY;AACrC,cAAQ,IAAI;AAAA,8BAAiC;AAC7C,UAAI;AACF,cAAMH,IAAO,MAAMX,EAAaC,GAAYC,CAAO;AAEnD,QAAI,CAACA,EAAQ,UAAUS,IACrB,QAAQ,IAAIA,CAAI,IACPT,EAAQ,UACjB,QAAQ,IAAI,qBAAqBA,EAAQ,MAAM,EAAE;AAAA,MAErD,SAASU,GAAO;AACd,QAAIA,aAAiB,QACnB,QAAQ,MAAM,UAAUA,EAAM,OAAO,EAAE,IAEvC,QAAQ,MAAM,UAAUA,CAAK;AAAA,MAEjC;AAAA,IACF,GAAG,GAAG;AAAA,EAEV,CAAC;AACH;AAEAvB,EACG,QAAQ,UAAU,EAClB,YAAY,yCAAyC,EACrD,SAAS,YAAY,6BAA6B,EAClD,OAAO,uBAAuB,kBAAkB,EAChD,OAAO,2BAA2B,gDAAgD,YAAY,EAC9F,OAAO,oBAAoB,qDAAqD,EAChF,OAAO,eAAe,uCAAuC,EAC7D,OAAO,OAAOmB,GAAgBN,MAAoC;AAEjE,QAAMe,IAA2B,CAAC,cAAc,SAAS,QAAQ;AACjE,EAAKA,EAAc,SAASf,EAAQ,OAAO,MACzC,QAAQ;AAAA,IACN,2BAA2BA,EAAQ,OAAO,qBAAqBe,EAAc,KAAK,IAAI,CAAC;AAAA,EAAA,GAEzF,QAAQ,KAAK,CAAC,IAIhB,MAAMV,EAAYC,GAAQN,CAAO,GAG7BA,EAAQ,SACVW,EAAYL,GAAQN,CAAO;AAE/B,CAAC;AAEHb,EAAQ,MAAA;"}