@rawsql-ts/ddl-docs-vitepress 0.2.1 → 0.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MSugiura
+
+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.md

@@ -1,105 +1,105 @@
-# @rawsql-ts/ddl-docs-vitepress
-
-A scaffold generator for VitePress-based database schema documentation sites.
-
-This package provides the `ddl-docs-vitepress init` command, which creates a ready-to-use project template that:
-
-- reads SQL files from `ddl/`
-- generates Markdown docs via `@rawsql-ts/ddl-docs-cli`
-- serves/builds a VitePress site from `docs/`
-
-## Generated project structure
-
-```
-my-db-docs/
-├── .github/workflows/deploy-docs.yml   # GitHub Pages deploy workflow
-├── .gitignore
-├── ddl/.gitkeep                        # Place your .sql files here
-├── docs/
-│   ├── index.md
-│   └── .vitepress/
-│       ├── config.mts
-│       └── theme/
-│           ├── custom.css
-│           └── index.ts
-├── package.json
-└── scripts/run-generate.cjs            # Calls ddl-docs-cli to generate Markdown
-```
-
-## Create a scaffold project
-
-```bash
-npx @rawsql-ts/ddl-docs-vitepress init my-db-docs
-cd my-db-docs
-npm install
-```
-
-### Safe-by-default init behavior
-
-- If target directory does not exist: scaffold is created.
-- If target directory exists and is empty: scaffold is created.
-- If target directory exists and is not empty: command fails by default.
-- Use `--force` to overwrite template paths in a non-empty directory.
-- `--force` is overwrite-only. It does not remove non-template files.
-- Use `--force --clean` to remove non-template files before scaffolding.
-
-```bash
-npx @rawsql-ts/ddl-docs-vitepress init existing-dir --force
-npx @rawsql-ts/ddl-docs-vitepress init existing-dir --force --clean
-```
-
-Warning: `--clean` removes non-template files and directories in the target path.
-
-### Help
-
-```bash
-npx @rawsql-ts/ddl-docs-vitepress --help
-npx @rawsql-ts/ddl-docs-vitepress help
-npx @rawsql-ts/ddl-docs-vitepress init --help
-```
-
-## Use the generated scaffold project
-
-In the generated project:
-
-1. Put your `.sql` files under `ddl/`.
-   The build script applies `--filter-pg-dump` automatically, so `pg_dump` output can be used directly — statements such as `SET`, `ALTER ... OWNER TO`, and `SELECT pg_catalog.*` are filtered out before parsing.
-2. Start local development:
-
-```bash
-npm run dev
-```
-
-3. Build static docs:
-
-```bash
-npm run build
-```
-
-4. Preview the built site:
-
-```bash
-npm run preview
-```
-
-### GitHub Pages deployment
-
-The scaffold includes `.github/workflows/deploy-docs.yml` which automatically builds and deploys docs to GitHub Pages on pushes to `main` that touch `ddl/` or `docs/.vitepress/`. The workflow sets `VITEPRESS_BASE` from the repository name.
-
-To enable it, go to your repository's **Settings > Pages** and set the source to **GitHub Actions**.
-
-### `VITEPRESS_BASE` for subpath hosting
-
-The scaffold template uses `process.env.VITEPRESS_BASE ?? '/'` in `docs/.vitepress/config.mts`.
-Set `VITEPRESS_BASE` when deploying under a subpath (for example GitHub Pages):
-
-```bash
-VITEPRESS_BASE=/my-repo/ npm run build
-```
-
-## Scripts in this package (maintainer note)
-
-In `packages/ddl-docs-vitepress` itself:
-
-- `pnpm build` compiles this CLI package with `tsc`.
-- It does **not** build the generated VitePress docs site.
+# @rawsql-ts/ddl-docs-vitepress
+
+A scaffold generator for VitePress-based database schema documentation sites.
+
+This package provides the `ddl-docs-vitepress init` command, which creates a ready-to-use project template that:
+
+- reads SQL files from `ddl/`
+- generates Markdown docs via `@rawsql-ts/ddl-docs-cli`
+- serves/builds a VitePress site from `docs/`
+
+## Generated project structure
+
+```
+my-db-docs/
+├── .github/workflows/deploy-docs.yml   # GitHub Pages deploy workflow
+├── .gitignore
+├── ddl/.gitkeep                        # Place your .sql files here
+├── docs/
+│   ├── index.md
+│   └── .vitepress/
+│       ├── config.mts
+│       └── theme/
+│           ├── custom.css
+│           └── index.ts
+├── package.json
+└── scripts/run-generate.cjs            # Calls ddl-docs-cli to generate Markdown
+```
+
+## Create a scaffold project
+
+```bash
+npx @rawsql-ts/ddl-docs-vitepress init my-db-docs
+cd my-db-docs
+npm install
+```
+
+### Safe-by-default init behavior
+
+- If target directory does not exist: scaffold is created.
+- If target directory exists and is empty: scaffold is created.
+- If target directory exists and is not empty: command fails by default.
+- Use `--force` to overwrite template paths in a non-empty directory.
+- `--force` is overwrite-only. It does not remove non-template files.
+- Use `--force --clean` to remove non-template files before scaffolding.
+
+```bash
+npx @rawsql-ts/ddl-docs-vitepress init existing-dir --force
+npx @rawsql-ts/ddl-docs-vitepress init existing-dir --force --clean
+```
+
+Warning: `--clean` removes non-template files and directories in the target path.
+
+### Help
+
+```bash
+npx @rawsql-ts/ddl-docs-vitepress --help
+npx @rawsql-ts/ddl-docs-vitepress help
+npx @rawsql-ts/ddl-docs-vitepress init --help
+```
+
+## Use the generated scaffold project
+
+In the generated project:
+
+1. Put your `.sql` files under `ddl/`.
+   The build script applies `--filter-pg-dump` automatically, so `pg_dump` output can be used directly — statements such as `SET`, `ALTER ... OWNER TO`, and `SELECT pg_catalog.*` are filtered out before parsing.
+2. Start local development:
+
+```bash
+npm run dev
+```
+
+3. Build static docs:
+
+```bash
+npm run build
+```
+
+4. Preview the built site:
+
+```bash
+npm run preview
+```
+
+### GitHub Pages deployment
+
+The scaffold includes `.github/workflows/deploy-docs.yml` which automatically builds and deploys docs to GitHub Pages on pushes to `main` that touch `ddl/` or `docs/.vitepress/`. The workflow sets `VITEPRESS_BASE` from the repository name.
+
+To enable it, go to your repository's **Settings > Pages** and set the source to **GitHub Actions**.
+
+### `VITEPRESS_BASE` for subpath hosting
+
+The scaffold template uses `process.env.VITEPRESS_BASE ?? '/'` in `docs/.vitepress/config.mts`.
+Set `VITEPRESS_BASE` when deploying under a subpath (for example GitHub Pages):
+
+```bash
+VITEPRESS_BASE=/my-repo/ npm run build
+```
+
+## Scripts in this package (maintainer note)
+
+In `packages/ddl-docs-vitepress` itself:
+
+- `pnpm build` compiles this CLI package with `tsc`.
+- It does **not** build the generated VitePress docs site.

package/dist/cli.js

@@ -101,38 +101,38 @@ async function runInit(args) {
     console.log('  npm run dev');
 }
 function printGlobalHelp() {
-    console.log(`ddl-docs-vitepress <command> [options]
-
-Commands:
-  init [targetDir]   Scaffold a new DDL docs VitePress project (default: current directory)
-  help [command]     Show global help or command help
-
-Options:
-  --help, -h         Show this help message
-
-Init options:
-  --force            Overwrite template output paths in a non-empty directory (no deletion)
-  --clean            Delete non-template files before scaffolding (requires --force)
-
-Examples:
-  ddl-docs-vitepress init my-db-docs
-  ddl-docs-vitepress init existing-dir --force
-  ddl-docs-vitepress init existing-dir --force --clean
-  ddl-docs-vitepress help init
+    console.log(`ddl-docs-vitepress <command> [options]
+
+Commands:
+  init [targetDir]   Scaffold a new DDL docs VitePress project (default: current directory)
+  help [command]     Show global help or command help
+
+Options:
+  --help, -h         Show this help message
+
+Init options:
+  --force            Overwrite template output paths in a non-empty directory (no deletion)
+  --clean            Delete non-template files before scaffolding (requires --force)
+
+Examples:
+  ddl-docs-vitepress init my-db-docs
+  ddl-docs-vitepress init existing-dir --force
+  ddl-docs-vitepress init existing-dir --force --clean
+  ddl-docs-vitepress help init
 `);
 }
 function printInitHelp() {
-    console.log(`ddl-docs-vitepress init [targetDir] [options]
-
-Options:
-  --force            Overwrite template output paths in a non-empty directory (does not delete other files)
-  --clean            Delete non-template files before scaffolding (requires --force)
-  --help, -h         Show init help
-
-Examples:
-  ddl-docs-vitepress init docs-site
-  ddl-docs-vitepress init docs-site --force
-  ddl-docs-vitepress init docs-site --force --clean
+    console.log(`ddl-docs-vitepress init [targetDir] [options]
+
+Options:
+  --force            Overwrite template output paths in a non-empty directory (does not delete other files)
+  --clean            Delete non-template files before scaffolding (requires --force)
+  --help, -h         Show init help
+
+Examples:
+  ddl-docs-vitepress init docs-site
+  ddl-docs-vitepress init docs-site --force
+  ddl-docs-vitepress init docs-site --force --clean
 `);
 }
 function collectTemplateLayout(templatesDir) {

package/package.json

@@ -1,46 +1,50 @@
-{
-  "name": "@rawsql-ts/ddl-docs-vitepress",
-  "version": "0.2.1",
-  "description": "Scaffold generator for VitePress-based DB schema docs powered by ddl-docs-cli",
-  "main": "dist/index.js",
-  "bin": {
-    "ddl-docs-vitepress": "dist/index.js"
-  },
-  "scripts": {
-    "prepack": "node ./scripts/prepack.cjs",
-    "build": "tsc -p tsconfig.json",
-    "test": "vitest run packages/ddl-docs-vitepress/tests",
-    "generate": "node ./scripts/run-generate.cjs",
-    "dev": "pnpm generate && vitepress dev docs",
-    "preview": "vitepress preview docs"
-  },
-  "keywords": [
-    "rawsql-ts",
-    "ddl",
-    "vitepress",
-    "docs",
-    "scaffold",
-    "cli"
-  ],
-  "author": "msugiura",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "files": [
-    "dist",
-    "templates",
-    "README.md"
-  ],
-  "dependencies": {
-    "@rawsql-ts/ddl-docs-cli": "workspace:^"
-  },
-  "devDependencies": {
-    "@types/node": "^22.13.10",
-    "typescript": "^5.8.2",
-    "vitest": "^4.0.7"
-  }
-}
+{
+  "name": "@rawsql-ts/ddl-docs-vitepress",
+  "version": "0.2.3",
+  "description": "Scaffold generator for VitePress-based DB schema docs powered by ddl-docs-cli",
+  "main": "dist/index.js",
+  "bin": {
+    "ddl-docs-vitepress": "dist/index.js"
+  },
+  "keywords": [
+    "rawsql-ts",
+    "ddl",
+    "vitepress",
+    "docs",
+    "scaffold",
+    "cli"
+  ],
+  "author": "msugiura",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mk3008/rawsql-ts",
+    "directory": "packages/ddl-docs-vitepress"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "dependencies": {
+    "@rawsql-ts/ddl-docs-cli": "^0.2.4"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "typescript": "^5.8.2",
+    "vitest": "^4.0.7"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run packages/ddl-docs-vitepress/tests",
+    "generate": "node ./scripts/run-generate.cjs",
+    "dev": "pnpm generate && vitepress dev docs",
+    "preview": "vitepress preview docs"
+  }
+}

package/templates/.github/workflows/deploy-docs.yml

@@ -1,53 +1,53 @@
-name: Deploy Docs
-
-on:
-  push:
-    branches: [main]
-    paths:
-      - 'ddl/**'
-      - 'docs/**'
-      - 'docs/.vitepress/**'
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-concurrency:
-  group: pages
-  cancel-in-progress: true
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5
-
-      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020
-        with:
-          node-version: 20
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Generate and build docs
-        env:
-          VITEPRESS_BASE: /${{ github.event.repository.name }}/
-        run: npm run build
-
-      - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
-        with:
-          path: docs/.vitepress/dist
-
-  deploy:
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      pages: write
-      id-token: write
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'ddl/**'
+      - 'docs/**'
+      - 'docs/.vitepress/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5
+
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate and build docs
+        env:
+          VITEPRESS_BASE: /${{ github.event.repository.name }}/
+        run: npm run build
+
+      - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e

package/templates/docs/.vitepress/config.mts

@@ -1,12 +1,12 @@
-import { defineConfig } from 'vitepress'
-
-export default defineConfig({
-  title: 'DB Schema Docs',
-  description: 'Database schema documentation generated from DDL',
-  base: process.env.VITEPRESS_BASE ?? '/',
-  srcDir: '.',
-  themeConfig: {
-    search: { provider: 'local' },
-    aside: false,
-  },
-})
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: 'DB Schema Docs',
+  description: 'Database schema documentation generated from DDL',
+  base: process.env.VITEPRESS_BASE ?? '/',
+  srcDir: '.',
+  themeConfig: {
+    search: { provider: 'local' },
+    aside: false,
+  },
+})

package/templates/docs/.vitepress/theme/custom.css

@@ -1,13 +1,13 @@
-.VPDoc .container,
-.VPDoc .content-container,
-.VPDoc .content {
-  max-width: none !important;
-  width: 100% !important;
-}
-
-.VPNavBar .wrapper,
-.VPNavBar .container {
-  max-width: none !important;
-  margin-left: 0 !important;
-  padding-left: 16px !important;
-}
+.VPDoc .container,
+.VPDoc .content-container,
+.VPDoc .content {
+  max-width: none !important;
+  width: 100% !important;
+}
+
+.VPNavBar .wrapper,
+.VPNavBar .container {
+  max-width: none !important;
+  margin-left: 0 !important;
+  padding-left: 16px !important;
+}

package/templates/docs/.vitepress/theme/index.ts

@@ -1,4 +1,4 @@
-import DefaultTheme from 'vitepress/theme'
-import './custom.css'
-
-export default DefaultTheme
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default DefaultTheme

package/templates/docs/index.md

@@ -1,31 +1,31 @@
----
-layout: home
-
-hero:
-  name: DB Schema Docs
-  text: Database schema documentation
-  tagline: Generated automatically from DDL files
-  actions:
-    - theme: brand
-      text: Browse Tables
-      link: /tables/
-
-features:
-  - title: DDL-driven
-    details: Place your .sql files in the ddl/ directory and documentation is generated automatically.
-  - title: Always up to date
-    details: Run npm run dev or npm run build to regenerate docs from the latest DDL.
-  - title: Searchable
-    details: Full-text search across all table and column documentation.
----
-
-## Getting Started
-
-1. Add your DDL files to the `ddl/` directory.
-2. Run `npm run dev` to start the documentation site.
-
-```bash
-npm run dev
-```
-
-The `generate` step runs automatically before the dev server or build starts.
+---
+layout: home
+
+hero:
+  name: DB Schema Docs
+  text: Database schema documentation
+  tagline: Generated automatically from DDL files
+  actions:
+    - theme: brand
+      text: Browse Tables
+      link: /tables/
+
+features:
+  - title: DDL-driven
+    details: Place your .sql files in the ddl/ directory and documentation is generated automatically.
+  - title: Always up to date
+    details: Run npm run dev or npm run build to regenerate docs from the latest DDL.
+  - title: Searchable
+    details: Full-text search across all table and column documentation.
+---
+
+## Getting Started
+
+1. Add your DDL files to the `ddl/` directory.
+2. Run `npm run dev` to start the documentation site.
+
+```bash
+npm run dev
+```
+
+The `generate` step runs automatically before the dev server or build starts.

package/templates/gitignore

@@ -1,4 +1,4 @@
-docs/tables/
-docs/.vitepress/dist/
-docs/.vitepress/cache/
-node_modules/
+docs/tables/
+docs/.vitepress/dist/
+docs/.vitepress/cache/
+node_modules/

package/templates/package.json

@@ -1,18 +1,18 @@
-{
-  "name": "db-docs",
-  "version": "0.1.0",
-  "private": true,
-  "scripts": {
-    "generate": "node ./scripts/run-generate.cjs",
-    "dev": "node ./scripts/run-generate.cjs && vitepress dev docs",
-    "build": "node ./scripts/run-generate.cjs && vitepress build docs",
-    "preview": "vitepress preview docs"
-  },
-  "devDependencies": {
-    "@rawsql-ts/ddl-docs-cli": "^0.1.0",
-    "vitepress": "^1.6.4"
-  },
-  "engines": {
-    "node": ">=20"
-  }
-}
+{
+  "name": "db-docs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "generate": "node ./scripts/run-generate.cjs",
+    "dev": "node ./scripts/run-generate.cjs && vitepress dev docs",
+    "build": "node ./scripts/run-generate.cjs && vitepress build docs",
+    "preview": "vitepress preview docs"
+  },
+  "devDependencies": {
+    "@rawsql-ts/ddl-docs-cli": "^0.1.0",
+    "vitepress": "^1.6.4"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/scripts/run-generate.cjs

@@ -1,39 +1,39 @@
-const { readdirSync, existsSync } = require("node:fs");
-const { spawnSync } = require("node:child_process");
-
-const ddlDir = "ddl";
-
-let cliEntry;
-try {
-  cliEntry = require.resolve("@rawsql-ts/ddl-docs-cli");
-} catch {
-  console.error("@rawsql-ts/ddl-docs-cli is not installed. Run: npm install");
-  process.exit(1);
-}
-
-const hasSqlInputs =
-  existsSync(ddlDir) &&
-  readdirSync(ddlDir, { recursive: true }).some(
-    (entry) => typeof entry === "string" && entry.endsWith(".sql"),
-  );
-
-if (!hasSqlInputs) {
-  console.log("No SQL files found in ddl/. Skipping ddl-docs generation.");
-  process.exit(0);
-}
-
-const args = [
-  cliEntry,
-  "generate",
-  "--ddl-dir",
-  "ddl",
-  "--out-dir",
-  "docs/tables",
-  "--label-separator",
-  " :",
-  // Accept pg_dump output directly by filtering admin-only statements first.
-  "--filter-pg-dump",
-];
-
-const result = spawnSync(process.execPath, args, { stdio: "inherit" });
-process.exit(result.status ?? 1);
+const { readdirSync, existsSync } = require("node:fs");
+const { spawnSync } = require("node:child_process");
+
+const ddlDir = "ddl";
+
+let cliEntry;
+try {
+  cliEntry = require.resolve("@rawsql-ts/ddl-docs-cli");
+} catch {
+  console.error("@rawsql-ts/ddl-docs-cli is not installed. Run: npm install");
+  process.exit(1);
+}
+
+const hasSqlInputs =
+  existsSync(ddlDir) &&
+  readdirSync(ddlDir, { recursive: true }).some(
+    (entry) => typeof entry === "string" && entry.endsWith(".sql"),
+  );
+
+if (!hasSqlInputs) {
+  console.log("No SQL files found in ddl/. Skipping ddl-docs generation.");
+  process.exit(0);
+}
+
+const args = [
+  cliEntry,
+  "generate",
+  "--ddl-dir",
+  "ddl",
+  "--out-dir",
+  "docs/tables",
+  "--label-separator",
+  " :",
+  // Accept pg_dump output directly by filtering admin-only statements first.
+  "--filter-pg-dump",
+];
+
+const result = spawnSync(process.execPath, args, { stdio: "inherit" });
+process.exit(result.status ?? 1);