@rawsql-ts/ddl-docs-cli 0.2.2 → 0.2.4

package/AGENTS.md

@@ -1,27 +1,27 @@
-# Package Scope
-- Applies to `packages/ddl-docs-cli`.
-- Defines contract rules for the development CLI package.
-
-# Policy
-## REQUIRED
-- SQL parsing behavior MUST stay AST-first through `rawsql-ts` APIs.
-- Regex parsing fallback MUST be guarded and limited to unsupported AST gaps.
-- Package dependency footprint MUST remain minimal.
-
-## ALLOWED
-- CLI-only development usage MAY depend on package-local tooling.
-
-## PROHIBITED
-- Treating this package as runtime application `src/` dependency.
-
-# Mandatory Workflow
-- Before committing changes under `packages/ddl-docs-cli`, run:
-  - `pnpm --filter @rawsql-ts/ddl-docs-cli lint`
-  - `pnpm --filter @rawsql-ts/ddl-docs-cli test`
-  - `pnpm --filter @rawsql-ts/ddl-docs-cli build`
-
-# Hygiene
-- Temporary debug output MUST be removed before commit.
-
-# References
-- Parent policy context: [../../AGENTS.md](../../AGENTS.md)
+# Package Scope
+- Applies to `packages/ddl-docs-cli`.
+- Defines contract rules for the development CLI package.
+
+# Policy
+## REQUIRED
+- SQL parsing behavior MUST stay AST-first through `rawsql-ts` APIs.
+- Regex parsing fallback MUST be guarded and limited to unsupported AST gaps.
+- Package dependency footprint MUST remain minimal.
+
+## ALLOWED
+- CLI-only development usage MAY depend on package-local tooling.
+
+## PROHIBITED
+- Treating this package as runtime application `src/` dependency.
+
+# Mandatory Workflow
+- Before committing changes under `packages/ddl-docs-cli`, run:
+  - `pnpm --filter @rawsql-ts/ddl-docs-cli lint`
+  - `pnpm --filter @rawsql-ts/ddl-docs-cli test`
+  - `pnpm --filter @rawsql-ts/ddl-docs-cli build`
+
+# Hygiene
+- Temporary debug output MUST be removed before commit.
+
+# References
+- Parent policy context: [../../AGENTS.md](../../AGENTS.md)

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,86 +1,86 @@
-# @rawsql-ts/ddl-docs-cli
-
-Generate Markdown table definition documents from DDL files.
-
-- DDL is treated as SSOT.
-- SQL parsing uses `rawsql-ts`.
-- `CREATE TABLE` and `ALTER TABLE ... ADD CONSTRAINT` are applied across the full DDL stream.
-- `COMMENT ON TABLE/COLUMN` is parsed via `rawsql-ts`.
-
-## Install
-
-```bash
-pnpm --filter @rawsql-ts/ddl-docs-cli build
-```
-
-## Usage
-
-```bash
-ddl-docs generate --ddl-dir ztd/ddl --out-dir ztd/docs/tables
-```
-
-Show help:
-
-```bash
-ddl-docs help
-ddl-docs help generate
-ddl-docs help prune
-```
-
-Generated layout:
-
-- `ztd/docs/tables/index.md`
-- `ztd/docs/tables/<schema>/index.md`
-- `ztd/docs/tables/<schema>/<table>.md`
-
-Options:
-
-- `--ddl-dir <directory>` repeatable recursive directory input
-- `--ddl-file <file>` repeatable explicit file input
-- `--ddl <file>` alias of `--ddl-file`
-- `--ddl-glob <pattern>` repeatable glob pattern input
-- `--extensions <csv>` default `.sql`
-- `--out-dir <directory>` output root (default `ztd/docs/tables`)
-- `--config <path>` optional `ztd.config.json` path
-- `--default-schema <name>` schema override for unqualified table names
-- `--search-path <csv>` schema search path override
-- `--no-index` skip index page generation
-- `--strict` fail when warnings exist
-- `--column-order <mode>` `definition` (default) or `name`
-
-Prune generated files:
-
-```bash
-ddl-docs prune --out-dir ztd/docs/tables
-```
-
-Prune preview:
-
-```bash
-ddl-docs prune --out-dir ztd/docs/tables --dry-run
-```
-
-Optional orphan cleanup:
-
-```bash
-ddl-docs prune --out-dir ztd/docs/tables --prune-orphans
-```
-
-## VitePress Integration
-
-This tool emits plain Markdown files and index pages.
-If you prefer VitePress-side navigation generation, run with `--no-index` and let your site config build navigation from the generated table pages.
-
-## Warnings
-
-Warnings are emitted to `<outDir>/_meta/warnings.json`.
-Use `--strict` in CI to treat warnings as failures.
-
-## Memory Notes
-
-Current implementation prioritizes correctness by applying the full DDL stream and aggregating table metadata before rendering.
-For large schemas (for example, ~300 tables), follow-up optimization should focus on reducing peak memory by keeping only compact table metadata and discarding statement-level objects early.
-
-## Minimal E2E Sample
-
-See `packages/ddl-docs-cli/examples/minimal-e2e`.
+# @rawsql-ts/ddl-docs-cli
+
+Generate Markdown table definition documents from DDL files.
+
+- DDL is treated as SSOT.
+- SQL parsing uses `rawsql-ts`.
+- `CREATE TABLE` and `ALTER TABLE ... ADD CONSTRAINT` are applied across the full DDL stream.
+- `COMMENT ON TABLE/COLUMN` is parsed via `rawsql-ts`.
+
+## Install
+
+```bash
+pnpm --filter @rawsql-ts/ddl-docs-cli build
+```
+
+## Usage
+
+```bash
+ddl-docs generate --ddl-dir ztd/ddl --out-dir ztd/docs/tables
+```
+
+Show help:
+
+```bash
+ddl-docs help
+ddl-docs help generate
+ddl-docs help prune
+```
+
+Generated layout:
+
+- `ztd/docs/tables/index.md`
+- `ztd/docs/tables/<schema>/index.md`
+- `ztd/docs/tables/<schema>/<table>.md`
+
+Options:
+
+- `--ddl-dir <directory>` repeatable recursive directory input
+- `--ddl-file <file>` repeatable explicit file input
+- `--ddl <file>` alias of `--ddl-file`
+- `--ddl-glob <pattern>` repeatable glob pattern input
+- `--extensions <csv>` default `.sql`
+- `--out-dir <directory>` output root (default `ztd/docs/tables`)
+- `--config <path>` optional `ztd.config.json` path
+- `--default-schema <name>` schema override for unqualified table names
+- `--search-path <csv>` schema search path override
+- `--no-index` skip index page generation
+- `--strict` fail when warnings exist
+- `--column-order <mode>` `definition` (default) or `name`
+
+Prune generated files:
+
+```bash
+ddl-docs prune --out-dir ztd/docs/tables
+```
+
+Prune preview:
+
+```bash
+ddl-docs prune --out-dir ztd/docs/tables --dry-run
+```
+
+Optional orphan cleanup:
+
+```bash
+ddl-docs prune --out-dir ztd/docs/tables --prune-orphans
+```
+
+## VitePress Integration
+
+This tool emits plain Markdown files and index pages.
+If you prefer VitePress-side navigation generation, run with `--no-index` and let your site config build navigation from the generated table pages.
+
+## Warnings
+
+Warnings are emitted to `<outDir>/_meta/warnings.json`.
+Use `--strict` in CI to treat warnings as failures.
+
+## Memory Notes
+
+Current implementation prioritizes correctness by applying the full DDL stream and aggregating table metadata before rendering.
+For large schemas (for example, ~300 tables), follow-up optimization should focus on reducing peak memory by keeping only compact table metadata and discarding statement-level objects early.
+
+## Minimal E2E Sample
+
+See `packages/ddl-docs-cli/examples/minimal-e2e`.

package/dist/src/cli.js

@@ -219,29 +219,29 @@ function dedupe(values) {
     return Array.from(new Set(values));
 }
 function printHelp(target) {
-    const generateHelp = `ddl-docs generate [options]
-  --ddl-instance <name>   DB instance name for subsequent --ddl-dir/--ddl-file/--ddl-glob (repeatable)
-  --ddl-dir <directory>   Recursively scan DDL files under directory (repeatable)
-  --ddl-file <file>       Include explicit DDL file (repeatable)
-  --ddl <file>            Alias of --ddl-file
-  --ddl-glob <pattern>    Glob pattern for DDL files (repeatable)
-  --extensions <list>     Comma-separated extensions (default: .sql)
-  --out-dir <directory>   Output root directory (default: ztd/docs/tables)
-  --config <path>         Optional ztd.config.json path
-  --dictionary <path>     Optional column dictionary json
-  --locale <code>         Dictionary locale (fallback: LANG -> en -> first)
-  --default-schema <name> Override default schema for unqualified tables
-  --search-path <list>    Comma-separated schema search path
-  --no-index              Skip schema/table index page generation
-  --strict                Exit non-zero when warnings exist
-  --column-order <mode>   Column order: definition|name (default: definition)
-  --label-separator <pat> Regex to split comment into Label+Comment columns (if omitted, no Label column)
-  --filter-pg-dump        Strip GRANT/REVOKE/OWNER TO/SET/\\connect statements from pg_dump output
+    const generateHelp = `ddl-docs generate [options]
+  --ddl-instance <name>   DB instance name for subsequent --ddl-dir/--ddl-file/--ddl-glob (repeatable)
+  --ddl-dir <directory>   Recursively scan DDL files under directory (repeatable)
+  --ddl-file <file>       Include explicit DDL file (repeatable)
+  --ddl <file>            Alias of --ddl-file
+  --ddl-glob <pattern>    Glob pattern for DDL files (repeatable)
+  --extensions <list>     Comma-separated extensions (default: .sql)
+  --out-dir <directory>   Output root directory (default: ztd/docs/tables)
+  --config <path>         Optional ztd.config.json path
+  --dictionary <path>     Optional column dictionary json
+  --locale <code>         Dictionary locale (fallback: LANG -> en -> first)
+  --default-schema <name> Override default schema for unqualified tables
+  --search-path <list>    Comma-separated schema search path
+  --no-index              Skip schema/table index page generation
+  --strict                Exit non-zero when warnings exist
+  --column-order <mode>   Column order: definition|name (default: definition)
+  --label-separator <pat> Regex to split comment into Label+Comment columns (if omitted, no Label column)
+  --filter-pg-dump        Strip GRANT/REVOKE/OWNER TO/SET/\\connect statements from pg_dump output
 `;
-    const pruneHelp = `ddl-docs prune [options]
-  --out-dir <directory>   Output root directory (default: ztd/docs/tables)
-  --dry-run               Print deletion targets without deleting files
-  --prune-orphans         Also prune generated markdown not listed in manifest
+    const pruneHelp = `ddl-docs prune [options]
+  --out-dir <directory>   Output root directory (default: ztd/docs/tables)
+  --dry-run               Print deletion targets without deleting files
+  --prune-orphans         Also prune generated markdown not listed in manifest
 `;
     if (target === 'generate') {
         console.log(generateHelp);
@@ -251,14 +251,14 @@ function printHelp(target) {
         console.log(pruneHelp);
         return;
     }
-    console.log(`ddl-docs <command> [options]
-
-Commands:
-  generate               Generate markdown docs from DDL
-  prune                  Remove stale generated markdown docs
-  help [command]         Show help for all commands or one command
-
-${generateHelp}
+    console.log(`ddl-docs <command> [options]
+
+Commands:
+  generate               Generate markdown docs from DDL
+  prune                  Remove stale generated markdown docs
+  help [command]         Show help for all commands or one command
+
+${generateHelp}
 ${pruneHelp}`);
 }
 //# sourceMappingURL=cli.js.map

package/package.json

@@ -1,43 +1,47 @@
-{
-  "name": "@rawsql-ts/ddl-docs-cli",
-  "version": "0.2.2",
-  "description": "CLI tool that generates Markdown table definition docs from DDL files using rawsql-ts",
-  "main": "dist/src/index.js",
-  "bin": {
-    "ddl-docs": "dist/src/index.js"
-  },
-  "scripts": {
-    "prepack": "node -e \"const fs=require('fs');const cp=require('child_process');const npm=process.platform==='win32'?'npm.cmd':'npm';if(!fs.existsSync('dist/src/index.js')){process.exit(cp.spawnSync(npm,['run','build'],{stdio:'inherit'}).status??1)}\"",
-    "build": "tsc -p tsconfig.json",
-    "test": "vitest run",
-    "lint": "eslint src --ext .ts"
-  },
-  "keywords": [
-    "rawsql-ts",
-    "ddl",
-    "markdown",
-    "docs",
-    "cli"
-  ],
-  "author": "msugiura",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "dependencies": {
-    "rawsql-ts": "workspace:^"
-  },
-  "devDependencies": {
-    "@types/node": "^22.13.10",
-    "typescript": "^5.8.2",
-    "vitest": "^4.0.7"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "AGENTS.md"
-  ]
-}
+{
+  "name": "@rawsql-ts/ddl-docs-cli",
+  "version": "0.2.4",
+  "description": "CLI tool that generates Markdown table definition docs from DDL files using rawsql-ts",
+  "main": "dist/src/index.js",
+  "bin": {
+    "ddl-docs": "dist/src/index.js"
+  },
+  "keywords": [
+    "rawsql-ts",
+    "ddl",
+    "markdown",
+    "docs",
+    "cli"
+  ],
+  "author": "msugiura",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mk3008/rawsql-ts",
+    "directory": "packages/ddl-docs-cli"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "rawsql-ts": "^0.17.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "typescript": "^5.8.2",
+    "vitest": "^4.0.7"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "AGENTS.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "lint": "eslint src --ext .ts"
+  }
+}