@dbml/cli 5.0.0 → 5.2.0

package/__tests__/sql2dbml/custom-error-column-comment-column-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-column-comment-column-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 5 column 19. Column "name" not found in table "Users"
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-column-comment-table-not-found --oracle/in-files/schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE Users (
+  id TEXT
+);
+
+COMMENT ON COLUMN Posts.title IS 'title';

package/__tests__/sql2dbml/custom-error-column-comment-table-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-column-comment-table-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 5 column 19. Table "Posts" not found
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-create-index-table-not-found --oracle/in-files/schema.sql

@@ -0,0 +1 @@
+CREATE UNIQUE INDEX idx ON Users(id);

package/__tests__/sql2dbml/custom-error-create-index-table-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-create-index-table-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 1 column 28. Table Users not found
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-table-comment-table-not-found --oracle/in-files/schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE Users (
+  id TEXT
+);
+
+COMMENT ON TABLE Posts IS 'id';

package/__tests__/sql2dbml/custom-error-table-comment-table-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-table-comment-table-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 5 column 18. Table "Posts" not found
+
+  A complete log can be found in:

package/__tests__/sql2dbml/filename --oracle --out-file/expect-out-files/schema.dbml

@@ -0,0 +1,83 @@
+Table "departments" {
+  "dept_id" NUMBER(10) [pk]
+  "dept_name" VARCHAR2(100)
+  "location_id" NUMBER(10)
+  "manager_id" NUMBER(10)
+}
+
+Table "locations" {
+  "location_id" NUMBER(10) [pk]
+  "city" VARCHAR2(100)
+  "country_code" CHAR(2)
+}
+
+Table "countries" {
+  "country_code" CHAR(2) [pk]
+  "country_name" VARCHAR2(100)
+}
+
+Table "employees" {
+  "emp_id" NUMBER(10) [pk]
+  "emp_name" VARCHAR2(100)
+  "department_id" NUMBER(10)
+  "manager_id" NUMBER(10)
+  "hire_date" DATE
+  "location_id" NUMBER(10)
+}
+
+Table "projects" {
+  "project_id" NUMBER(10) [pk]
+  "project_name" VARCHAR2(200)
+  "dept_id" NUMBER(10)
+  "lead_emp_id" NUMBER(10)
+  "backup_emp_id" NUMBER(10)
+}
+
+Table "assignments" {
+  "assignment_id" NUMBER(10) [pk]
+  "emp_id" NUMBER(10)
+  "project_id" NUMBER(10)
+  "start_date" DATE
+}
+
+Table "project_tasks" {
+  "project_id" NUMBER(10)
+  "task_id" NUMBER(10)
+  "task_name" VARCHAR2(200)
+  "assigned_emp_id" NUMBER(10)
+
+  Indexes {
+    (project_id, task_id) [pk]
+  }
+}
+
+Table "task_hours" {
+  "hour_id" NUMBER(10) [pk]
+  "project_id" NUMBER(10)
+  "task_id" NUMBER(10)
+  "hours_worked" NUMBER(5,2)
+}
+
+Ref "fk_emp_dept":"departments"."dept_id" < "employees"."department_id"
+
+Ref "fk_dept_location":"locations"."location_id" < "departments"."location_id"
+
+Ref "fk_loc_country":"countries"."country_code" < "locations"."country_code"
+
+Ref "fk_emp_manager":"employees"."emp_id" < "employees"."manager_id"
+
+Ref "fk_dept_manager":"employees"."emp_id" < "departments"."manager_id"
+
+Ref:"departments"."dept_id" < "projects"."dept_id"
+
+Ref:"employees"."emp_id" < "assignments"."emp_id"
+
+Ref:"projects"."project_id" < "assignments"."project_id"
+
+Ref "fk_task_hours_project_task":"project_tasks".("project_id", "task_id") < "task_hours".("project_id", "task_id")
+
+Ref "fk_proj_lead_emp":"employees"."emp_id" < "projects"."lead_emp_id"
+
+Ref "fk_proj_backup_emp":"employees"."emp_id" < "projects"."backup_emp_id"
+
+Ref "fk_task_assigned_emp":"employees"."emp_id" < "project_tasks"."assigned_emp_id"

package/__tests__/sql2dbml/filename --oracle --out-file/in-files/schema.sql

@@ -0,0 +1,147 @@
+-- Oracle SQL ALTER TABLE ADD FOREIGN KEY Constraint Test Cases
+-- Test setup: Create base tables with primary keys
+CREATE TABLE departments (
+    dept_id NUMBER(10) PRIMARY KEY,
+    dept_name VARCHAR2(100),
+    location_id NUMBER(10),
+    manager_id NUMBER(10)
+);
+
+CREATE TABLE locations (
+    location_id NUMBER(10) PRIMARY KEY,
+    city VARCHAR2(100),
+    country_code CHAR(2)
+);
+
+CREATE TABLE countries (
+    country_code CHAR(2) PRIMARY KEY,
+    country_name VARCHAR2(100)
+);
+
+CREATE TABLE employees (
+    emp_id NUMBER(10) PRIMARY KEY,
+    emp_name VARCHAR2(100),
+    department_id NUMBER(10),
+    manager_id NUMBER(10),
+    hire_date DATE,
+    location_id NUMBER(10)
+);
+
+CREATE TABLE projects (
+    project_id NUMBER(10) PRIMARY KEY,
+    project_name VARCHAR2(200),
+    dept_id NUMBER(10),
+    lead_emp_id NUMBER(10),
+    backup_emp_id NUMBER(10)
+);
+
+CREATE TABLE assignments (
+    assignment_id NUMBER(10) PRIMARY KEY,
+    emp_id NUMBER(10),
+    project_id NUMBER(10),
+    start_date DATE
+);
+
+-- Table with composite primary key
+CREATE TABLE project_tasks (
+    project_id NUMBER(10),
+    task_id NUMBER(10),
+    task_name VARCHAR2(200),
+    assigned_emp_id NUMBER(10),
+    PRIMARY KEY (project_id, task_id)
+);
+
+CREATE TABLE task_hours (
+    hour_id NUMBER(10) PRIMARY KEY,
+    project_id NUMBER(10),
+    task_id NUMBER(10),
+    hours_worked NUMBER(5,2)
+);
+
+-- ============================================
+-- NAMED FOREIGN KEY CONSTRAINTS - BASIC
+-- ============================================
+
+-- Simple single-column FK with constraint name
+ALTER TABLE employees 
+ADD CONSTRAINT fk_emp_dept 
+FOREIGN KEY (department_id) 
+REFERENCES departments(dept_id);
+
+-- Single-column FK referencing different table
+ALTER TABLE departments 
+ADD CONSTRAINT fk_dept_location 
+FOREIGN KEY (location_id) 
+REFERENCES locations(location_id);
+
+-- FK with explicit column name in referenced table
+ALTER TABLE locations 
+ADD CONSTRAINT fk_loc_country 
+FOREIGN KEY (country_code) 
+REFERENCES countries(country_code);
+
+-- Self-referencing FK (hierarchical)
+ALTER TABLE employees 
+ADD CONSTRAINT fk_emp_manager 
+FOREIGN KEY (manager_id) 
+REFERENCES employees(emp_id);
+
+-- Another self-referencing FK on different table
+ALTER TABLE departments 
+ADD CONSTRAINT fk_dept_manager 
+FOREIGN KEY (manager_id) 
+REFERENCES employees(emp_id);
+
+-- ============================================
+-- UNNAMED FOREIGN KEY CONSTRAINTS
+-- ============================================
+
+-- FK without explicit constraint name (Oracle auto-generates)
+ALTER TABLE projects 
+ADD FOREIGN KEY (dept_id) 
+REFERENCES departments(dept_id);
+
+-- Another unnamed FK
+ALTER TABLE assignments 
+ADD FOREIGN KEY (emp_id) 
+REFERENCES employees(emp_id);
+
+-- Unnamed FK with different columns
+ALTER TABLE assignments 
+ADD FOREIGN KEY (project_id) 
+REFERENCES projects(project_id);
+
+-- ============================================
+-- COMPOSITE FOREIGN KEYS (Multiple Columns)
+-- ============================================
+
+-- Two-column composite FK
+ALTER TABLE task_hours 
+ADD CONSTRAINT fk_task_hours_project_task 
+FOREIGN KEY (project_id, task_id) 
+REFERENCES project_tasks(project_id, task_id);
+
+-- ============================================
+-- FOREIGN KEYS WITH ON DELETE ACTIONS
+-- ============================================
+
+-- ON DELETE CASCADE - delete child records when parent is deleted
+ALTER TABLE projects 
+ADD CONSTRAINT fk_proj_lead_emp 
+FOREIGN KEY (lead_emp_id) 
+REFERENCES employees(emp_id) 
+ON DELETE CASCADE;
+
+-- ON DELETE SET NULL - set FK to NULL when parent is deleted
+ALTER TABLE projects 
+ADD CONSTRAINT fk_proj_backup_emp 
+FOREIGN KEY (backup_emp_id) 
+REFERENCES employees(emp_id) 
+ON DELETE SET NULL;
+
+-- ON DELETE CASCADE with named constraint
+ALTER TABLE project_tasks 
+ADD CONSTRAINT fk_task_assigned_emp 
+FOREIGN KEY (assigned_emp_id) 
+REFERENCES employees(emp_id) 
+ON DELETE CASCADE;

package/__tests__/sql2dbml/filename --oracle --out-file/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/filename --oracle --out-file/stdout.txt

@@ -0,0 +1 @@
+  ✔ Generated DBML file from SQL file (Oracle): schema.dbml

package/__tests__/sql2dbml/syntax-error/dbml-error.log

@@ -0,0 +1,9 @@
+2025-11-17T09:12:23.657Z
+undefined
+
+2025-11-17T09:52:17.717Z
+undefined
+
+2025-11-17T14:38:11.691Z
+undefined
+

package/__tests__/sql2dbml/syntax-error-duplicate-endpoints --mssql/dbml-error.log

@@ -0,0 +1,9 @@
+2025-11-17T09:12:24.842Z
+undefined
+
+2025-11-17T09:52:18.833Z
+undefined
+
+2025-11-17T14:38:12.931Z
+undefined
+

package/__tests__/sql2dbml/syntax-error-duplicate-endpoints --mysql/dbml-error.log

@@ -0,0 +1,9 @@
+2025-11-17T09:12:25.985Z
+undefined
+
+2025-11-17T09:52:19.827Z
+undefined
+
+2025-11-17T14:38:13.982Z
+undefined
+

package/{__test__ → __tests__}/sql2dbml_bin.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line
 require = require('esm')(module);
 const { sql2dbml } = require('../src');
 

package/bin/db2dbml.js

@@ -1,4 +1,3 @@
 #!/usr/bin/env node
-/* eslint-disable */
 
 require('../lib').db2dbml(process.argv);

package/bin/dbml2sql.js

@@ -1,4 +1,3 @@
 #!/usr/bin/env node
-/* eslint-disable */
 
 require('../lib').dbml2sql(process.argv);

package/bin/sql2dbml.js

@@ -1,4 +1,3 @@
 #!/usr/bin/env node
-/* eslint-disable */
 
 require('../lib').sql2dbml(process.argv);

package/eslint.config.ts

@@ -0,0 +1,96 @@
+import globals from 'globals';
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import stylistic from '@stylistic/eslint-plugin';
+import tseslint from 'typescript-eslint';
+import tsparser from '@typescript-eslint/parser';
+import jest from 'eslint-plugin-jest';
+
+export default defineConfig(
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  stylistic.configs.customize({
+    indent: 2,
+    semi: true,
+    arrowParens: true,
+    braceStyle: '1tbs',
+  }),
+  [
+    {
+      ignores: [
+        'node_modules/*',
+        'lib/*',
+        'bin/*',
+        'jestHelpers.js',
+        'eslint.config.ts',
+        'jest.config.ts',
+      ],
+    },
+    {
+      files: ['**/*.ts', '**/*.js'],
+      languageOptions: {
+        globals: {
+          ...globals.node,
+          ...globals.es2022,
+        },
+        parser: tsparser,
+        parserOptions: {
+          sourceType: 'module',
+          ecmaVersion: 2018,
+          project: './tsconfig.json',
+        },
+      },
+      plugins: {
+        '@stylistic': stylistic,
+      },
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+        'no-use-before-define': 'off',
+        'no-continue': 'off',
+        '@stylistic/space-before-function-paren': ['error', 'always'],
+        '@typescript-eslint/no-unused-vars': [
+          'warn',
+          {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: '^_',
+            caughtErrorsIgnorePattern: '^_',
+          },
+        ],
+        'consistent-return': 'off',
+        '@typescript-eslint/consistent-return': [
+          'error',
+        ],
+        '@stylistic/quotes': ['error', 'single', { 'avoidEscape': true }],
+        '@stylistic/max-statements-per-line': 'off',
+        '@stylistic/operator-linebreak': ['error', 'before', { overrides: { '=': 'after' } }],
+      },
+      settings: {
+        'import/resolver': {
+          typescript: {
+            alwaysTryTypes: true,
+            project: 'packages/*/{ts,js}config.json',
+          },
+        },
+      },
+    },
+    {
+      files: ['**/*.test.js', '**/*.spec.js'],
+      ...jest.configs['flat/recommended'],
+      languageOptions: {
+        globals: {
+          ...jest.environments.globals.globals,
+        },
+      },
+      rules: {
+        'no-undef': 'warn',
+      },
+    },
+    {
+      files: ['bin/**/*', '**/*.test.js', '**/*.spec.js', '__tests__/**/*'],
+      rules: {
+        '@typescript-eslint/no-require-imports': 'warn',
+        'no-global-assign': 'warn',
+      },
+    },
+  ],
+);

package/jest.config.ts

@@ -0,0 +1,13 @@
+import { type Config } from 'jest';
+
+const config: Config = {
+  testMatch: ["**/?(*.)+(spec|test).?([mc])[jt]s?(x)"],
+  setupFiles: [
+    "./jestHelpers.js",
+  ],
+  transform: {
+    "^.+\\.js$": "babel-jest",
+  },
+};
+
+export default config;

package/lib/cli/index.js

@@ -12,8 +12,6 @@ var _export = _interopRequireDefault(require("./export"));
 var _connector = _interopRequireDefault(require("./connector"));
 var _package = _interopRequireDefault(require("../../package.json"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/* eslint-disable max-len */
-
 function showHelp(args) {
   if (args.length < 3) _commander.default.help();
 }
@@ -28,7 +26,7 @@ function dbml2sql(args) {
 }
 function sql2dbml(args) {
   _commander.default.version(_package.default.version);
-  _commander.default.usage('[options] <files...>').option('--mysql').option('--mysql-legacy').option('--postgres').option('--postgres-legacy').option('--mssql').option('--mssql-legacy').option('--snowflake').option('-o, --out-file <pathspec>', 'compile all input files into a single files');
+  _commander.default.usage('[options] <files...>').option('--mysql').option('--mysql-legacy').option('--postgres').option('--postgres-legacy').option('--mssql').option('--mssql-legacy').option('--snowflake').option('--oracle').option('-o, --out-file <pathspec>', 'compile all input files into a single files');
   // .option('-d, --out-dir <pathspec>', 'compile an input directory of sql files into an output directory');
 
   showHelp(args);

package/lib/cli/utils.js

@@ -67,12 +67,14 @@ function generate(inputPaths, transform, outputPlugin) {
       const content = transform(source);
       outputPlugin.write(content);
     } catch (e) {
-      if (e instanceof _core.CompilerError) throw e.map(diag => ({
-        ...diag,
-        message: diag.message,
-        filepath: _path2.default.basename(_path),
-        stack: diag.stack
-      }));
+      if (e instanceof _core.CompilerError) {
+        throw e.map(diag => ({
+          ...diag,
+          message: diag.message,
+          filepath: _path2.default.basename(_path),
+          stack: diag.stack
+        }));
+      }
       throw e;
     }
   });

package/lib/helpers/logger.js

@@ -8,8 +8,6 @@ var _winston = require("winston");
 var _chalk = _interopRequireDefault(require("chalk"));
 var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/* eslint-disable import/no-import-module-exports */
-
 const {
   combine,
   timestamp,

package/package.json

@@ -1,13 +1,16 @@
 {
+  "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/cli",
-  "version": "5.0.0",
+  "version": "5.2.0",
   "description": "",
   "main": "lib/index.js",
   "license": "Apache-2.0",
   "scripts": {
     "test": "jest",
     "build": "babel src --out-dir lib --copy-files",
-    "prepublish": "npm run build"
+    "prepublish": "npm run build",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix ."
   },
   "publishConfig": {
     "access": "public"
@@ -26,8 +29,8 @@
   ],
   "dependencies": {
     "@babel/cli": "^7.21.0",
-    "@dbml/connector": "^5.0.0",
-    "@dbml/core": "^5.0.0",
+    "@dbml/connector": "^5.2.0",
+    "@dbml/core": "^5.2.0",
     "bluebird": "^3.5.5",
     "chalk": "^2.4.2",
     "commander": "^2.20.0",
@@ -44,18 +47,18 @@
     "@babel/plugin-transform-runtime": "^7.21.4",
     "@babel/preset-env": "^7.21.4",
     "@babel/runtime": "^7.21.0",
+    "@stylistic/eslint-plugin": "^5.5.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.3",
+    "@typescript-eslint/parser": "^8.46.3",
     "babel-jest": "^29.5.0",
-    "jest": "^29.5.0"
+    "eslint": "^9.39.1",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-jest": "^29.0.1",
+    "jest": "^29.5.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.3"
   },
-  "jest": {
-    "setupFiles": [
-      "./jestHelpers.js"
-    ],
-    "transform": {
-      "^.+\\.js$": "babel-jest"
-    }
-  },
-  "gitHead": "a2d029e9c3c78ab0956312495165ec3115b5bc00",
+  "gitHead": "20d556a6e6baad8a989c730e2afd3b65dedcea89",
   "engines": {
     "node": ">=18"
   }

package/src/cli/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-len */
 import program from 'commander';
 import importHandler from './import';
 import exportHandler from './export';
@@ -39,6 +38,7 @@ function sql2dbml (args) {
     .option('--mssql')
     .option('--mssql-legacy')
     .option('--snowflake')
+    .option('--oracle')
     .option('-o, --out-file <pathspec>', 'compile all input files into a single files');
   // .option('-d, --out-dir <pathspec>', 'compile an input directory of sql files into an output directory');
 

package/src/cli/utils.js

@@ -68,7 +68,11 @@ function generate (inputPaths, transform, outputPlugin) {
       const content = transform(source);
       outputPlugin.write(content);
     } catch (e) {
-      if (e instanceof CompilerError) throw e.map((diag) => ({ ...diag, message: diag.message, filepath: path.basename(_path), stack: diag.stack }));
+      if (e instanceof CompilerError) {
+        throw e.map((diag) => ({
+          ...diag, message: diag.message, filepath: path.basename(_path), stack: diag.stack,
+        }));
+      }
       throw e;
     }
   });

package/src/helpers/logger.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-import-module-exports */
 import { createLogger, format, transports } from 'winston';
 import chalk from 'chalk';
 import path from 'path';

package/tsconfig.json

@@ -1,10 +1,18 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "rootDirs": ["./src", "./"],                          /* Allow multiple folders to be treated as one when resolving modules. */
-    "baseUrl": "./src",                                   /* Specify the base directory to resolve non-relative module names. */
-    "outDir": "./lib"                                     /* Specify an output folder for all emitted files. */
+    "rootDirs": [
+      "./src",
+      "./"
+    ], /* Allow multiple folders to be treated as one when resolving modules. */
+    "baseUrl": "./src", /* Specify the base directory to resolve non-relative module names. */
+    "outDir": "./lib" /* Specify an output folder for all emitted files. */
   },
-  "files": ["package.json"],
-  "include": ["src/**/*", "__test__/**/*"]
+  "files": [
+    "package.json"
+  ],
+  "include": [
+    "src/**/*",
+    "__tests__/**/*"
+  ]
 }