@dbml/cli 7.0.0-alpha.1 → 7.1.0-alpha.0

package/src/cli/{import.js → import.ts}

@@ -1,27 +1,39 @@
-import { importer } from '@dbml/core';
-import figures from 'figures';
-import chalk from 'chalk';
 import path from 'path';
+import {
+  CompilerError, importer,
+} from '@dbml/core';
+import type {
+  ImportFormat,
+} from '@dbml/core';
+import chalk from 'chalk';
+import {
+  Command,
+} from 'commander';
+import figures from 'figures';
+import {
+  SyntaxError,
+} from '../errors';
+import logger from '../helpers/logger';
 import config from './config';
+import OutputConsolePlugin from './outputPlugins/outputConsolePlugin';
+import OutputFilePlugin from './outputPlugins/outputFilePlugin';
 import {
-  validateInputFilePaths,
-  resolvePaths,
-  getFormatOpt,
   generate,
+  getFormatOpt,
+  resolvePaths,
+  validateInputFilePaths,
 } from './utils';
-import { validateFilePlugin } from './validatePlugins/validatePlugins';
-import OutputConsolePlugin from './outputPlugins/outputConsolePlugin';
-import OutputFilePlugin from './outputPlugins/outputFilePlugin';
-import logger from '../helpers/logger';
-import { SyntaxError } from '../errors';
+import {
+  validateFilePlugin,
+} from './validatePlugins/validatePlugins';
 
-export default async function importHandler (program) {
+export default async function importHandler (program: Command) {
   try {
     const inputPaths = resolvePaths(program.args);
     validateInputFilePaths(inputPaths, validateFilePlugin);
     const opts = program.opts();
 
-    const format = getFormatOpt(opts);
+    const format = getFormatOpt(opts) as ImportFormat;
 
     if (!opts.outFile && !opts.outDir) {
       generate(inputPaths, (sql) => importer.import(sql, format), OutputConsolePlugin);
@@ -31,8 +43,10 @@ export default async function importHandler (program) {
       console.log(`  ${chalk.green(figures.main.tick)} Generated DBML file from SQL file (${config[format].name}): ${path.basename(opts.outFile)}`);
     }
   } catch (error) {
-    if ('diags' in error) {
-      logger.error(`\n    ${error.diags.map((diag) => new SyntaxError(diag.filepath, diag)).map(({ message }) => message).join('\n    ')}`);
+    if (error instanceof CompilerError) {
+      logger.error(`\n    ${error.diags.map((diag) => new SyntaxError(diag.filepath ?? '', diag)).map(({
+        message,
+      }) => message).join('\n    ')}`);
       return;
     }
     throw error;

package/src/cli/{index.js → index.ts}

@@ -1,14 +1,14 @@
 import program from 'commander';
-import importHandler from './import';
-import exportHandler from './export';
-import connectionHandler from './connector';
 import projectInfo from '../../package.json';
+import connectionHandler from './connector';
+import exportHandler from './export';
+import importHandler from './import';
 
-function showHelp (args) {
+function showHelp (args: string[]) {
   if (args.length < 3) program.help();
 }
 
-function dbml2sql (args) {
+function dbml2sql (args: string[]) {
   program.version(projectInfo.version);
 
   program
@@ -26,7 +26,7 @@ function dbml2sql (args) {
   exportHandler(program);
 }
 
-function sql2dbml (args) {
+function sql2dbml (args: string[]) {
   program.version(projectInfo.version);
 
   program
@@ -48,7 +48,7 @@ function sql2dbml (args) {
   importHandler(program);
 }
 
-function db2dbml (args) {
+function db2dbml (args: string[]) {
   program.version(projectInfo.version);
 
   const description = `Generate DBML directly from a database

package/src/cli/outputPlugins/{outputConsolePlugin.js → outputConsolePlugin.ts}

@@ -1,5 +1,5 @@
 class OutputConsolePlugin {
-  static write (content) {
+  static write (content: string) {
     console.log(content);
   }
 }

package/src/cli/outputPlugins/{outputFilePlugin.js → outputFilePlugin.ts}

@@ -1,7 +1,12 @@
 import fs from 'fs';
 
 class OutputFilePlugin {
-  constructor (filePath, header) {
+  filePath: string;
+  header: string | undefined;
+  isWrite: boolean;
+  stream!: fs.WriteStream;
+
+  constructor (filePath: string, header?: string) {
     this.filePath = filePath;
     this.header = header;
     this.isWrite = false;
@@ -9,12 +14,14 @@ class OutputFilePlugin {
 
   start () {
     fs.writeFileSync(this.filePath, '');
-    this.stream = fs.createWriteStream(this.filePath, { flags: 'a' });
+    this.stream = fs.createWriteStream(this.filePath, {
+      flags: 'a',
+    });
     if (this.header) this.stream.write(this.header);
     this.isWrite = true;
   }
 
-  write (content) {
+  write (content: string) {
     if (!this.isWrite) this.start();
     this.stream.write(content);
   }

package/src/cli/{utils.js → utils.ts}

@@ -1,41 +1,57 @@
-import path from 'path';
 import fs from 'fs';
-import { CompilerError } from '@dbml/core';
-import { reduce } from 'lodash-es';
+import path from 'path';
+import {
+  CompilerError,
+  type ExportFormat,
+} from '@dbml/core';
+import {
+  reduce,
+} from 'lodash-es';
+
+interface OutputPlugin {
+  write(content: string): void;
+}
+
+interface ConnectionOpt {
+  connection: string;
+  databaseType: string;
+}
 
-function resolvePaths (paths) {
+function resolvePaths (paths: string): string;
+function resolvePaths (paths: string[]): string[];
+function resolvePaths (paths: string | string[]): string | string[] {
   if (!Array.isArray(paths)) {
     return path.resolve(process.cwd(), paths);
   }
   return paths.map((_path) => path.resolve(process.cwd(), _path));
 }
 
-function validateInputFilePaths (paths, validatePlugin) {
+function validateInputFilePaths (paths: string[], validatePlugin: (_path: string) => void) {
   return paths.every((_path) => validatePlugin(_path));
 }
 
-function getFormatOpt (opts) {
+function getFormatOpt (opts: Record<string, unknown>): ExportFormat {
   const formatOpts = Object.keys(opts).filter((opt) => {
     return ['postgres', 'mysql', 'mssql', 'postgresLegacy', 'mysqlLegacy', 'mssqlLegacy', 'oracle', 'snowflake'].includes(opt);
   });
 
-  let format = 'postgres';
+  let format: ExportFormat = 'postgres';
   let cnt = 0;
 
   formatOpts.forEach((opt) => {
     if (opts[opt]) {
       cnt += 1;
       if (cnt > 1) throw new Error('Too many format options');
-      format = opt;
+      format = opt as ExportFormat;
     }
   });
 
-  return format;
+  return format as ExportFormat;
 }
 
-function getConnectionOpt (args) {
+function getConnectionOpt (args: string[]): ConnectionOpt {
   const supportedDatabases = ['postgres', 'mysql', 'mssql', 'snowflake', 'bigquery', 'oracle'];
-  const defaultConnectionOpt = {
+  const defaultConnectionOpt: ConnectionOpt = {
     connection: args[0],
     databaseType: 'unknown',
   };
@@ -61,7 +77,11 @@ function getConnectionOpt (args) {
   }, defaultConnectionOpt);
 }
 
-function generate (inputPaths, transform, outputPlugin) {
+function generate (
+  inputPaths: string[],
+  transform: (source: string) => string,
+  outputPlugin: OutputPlugin,
+): void {
   inputPaths.forEach((_path) => {
     const source = fs.readFileSync(_path, 'utf-8');
     try {
@@ -70,7 +90,10 @@ function generate (inputPaths, transform, outputPlugin) {
     } catch (e) {
       if (e instanceof CompilerError) {
         throw e.map((diag) => ({
-          ...diag, message: diag.message, filepath: path.basename(_path), stack: diag.stack,
+          ...diag,
+          message: diag.message,
+          filepath: path.basename(_path),
+          stack: diag.stack,
         }));
       }
       throw e;

package/src/cli/validatePlugins/{validatePlugins.js → validatePlugins.ts}

@@ -1,8 +1,8 @@
 import fs from 'fs';
 
-function validateFilePlugin (_path) {
+function validateFilePlugin (_path: string) {
   const stat = fs.statSync(_path);
-  if (stat.isDirectory(_path)) {
+  if (stat.isDirectory()) {
     throw new Error('Expect input to be files');
   }
 }

package/src/errors/{domainError.js → domainError.ts}

@@ -1,5 +1,7 @@
 class DomainError extends Error {
-  constructor (message, rootError = {}) {
+  rootError: unknown;
+
+  constructor (message: string, rootError: unknown = {}) {
     super(message);
     this.name = this.constructor.name;
     this.rootError = rootError;

package/src/errors/{syntaxError.js → syntaxError.ts}

@@ -1,8 +1,21 @@
-import { isEmpty } from 'lodash-es';
+import {
+  isEmpty,
+} from 'lodash-es';
 import DomainError from './domainError';
 
+interface RootError {
+  location?: {
+    start: {
+      line: number;
+      column: number;
+    };
+  };
+  message?: string;
+  stack?: unknown;
+}
+
 class SyntaxError extends DomainError {
-  constructor (fileName, rootError = {}) {
+  constructor (fileName: string, rootError: RootError = {}) {
     let message = `You have a syntax error at "${fileName}"`;
 
     if (rootError.location) {

package/src/helpers/{logger.js → logger.ts}

@@ -1,19 +1,30 @@
-import { createLogger, format, transports } from 'winston';
-import chalk from 'chalk';
 import path from 'path';
+import chalk from 'chalk';
+import {
+  createLogger, format, transports,
+} from 'winston';
 
-const { combine, timestamp, printf } = format;
+const {
+  combine, timestamp, printf,
+} = format;
 
 const consoleFormat = printf((info) => {
-  const { level, message } = info;
+  const {
+    level, message,
+  } = info;
   return `  ${chalk.red(level.toUpperCase())}: ${message}\n
   A complete log can be found in:
      ${path.resolve(process.cwd(), 'dbml-error.log')}`;
 });
 
 const fileFormat = printf((info) => {
-  const { timestamp, stack, rootError } = info;
-  let logContent = `${timestamp}\n${stack}\n`;
+  const {
+    timestamp: ts, stack, rootError,
+  } = info as unknown as { timestamp: string;
+    stack?: string;
+    rootError?: { stack?: string;
+      location?: unknown; }; };
+  let logContent = `${ts}\n${stack}\n`;
   if (rootError) {
     logContent += '\nROOT_ERROR:';
     logContent += `\n${rootError.stack}`;
@@ -30,7 +41,9 @@ const consoleLogger = createLogger({
     consoleFormat,
   ),
   transports: [
-    new transports.Console({ level: 'error' }),
+    new transports.Console({
+      level: 'error',
+    }),
   ],
 });
 
@@ -40,28 +53,28 @@ const fileLogger = createLogger({
     fileFormat,
   ),
   transports: [
-    new transports.File({ filename: 'dbml-error.log', level: 'error' }),
+    new transports.File({
+      filename: 'dbml-error.log',
+      level: 'error',
+    }),
   ],
 });
 
 const logger = {
-  debug (msg) {
+  debug (msg: string) {
     consoleLogger.debug(msg);
   },
-  info (msg) {
+  info (msg: string) {
     consoleLogger.info(msg);
   },
-  warn (msg) {
+  warn (msg: string) {
     consoleLogger.warn(msg);
   },
-  error (msg) {
+
+  error (msg: any) {
     consoleLogger.error(msg);
     fileLogger.error(msg);
   },
-  log (level, msg) {
-    const lvl = exports[level];
-    lvl(msg);
-  },
 };
 
 export default logger;

package/src/index.ts

@@ -0,0 +1,9 @@
+import {
+  db2dbml, dbml2sql, sql2dbml,
+} from './cli';
+
+export {
+  dbml2sql,
+  sql2dbml,
+  db2dbml,
+};

package/vite.config.ts

@@ -14,7 +14,7 @@ export default defineConfig({
     outDir: 'lib',
     minify: false,
     lib: {
-      entry: path.resolve(__dirname, 'src/index.js'),
+      entry: path.resolve(__dirname, 'src/index.ts'),
       fileName: 'index',
       formats: ['cjs'],
     },

package/__test__/dbml2sql/filename --mysql --out-file/dbml-error.log

@@ -1,36 +0,0 @@
-2021-07-13T12:37:40.734Z
-TypeError: Cannot read property 'tick' of undefined
-    at exportHandler (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\export.js:37:56)
-    at dbml2sql (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\index.js:19:3)
-    at Object.<anonymous> (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\__test__\dbml2sql_bin.js:5:1)
-    at Module._compile (internal/modules/cjs/loader.js:1085:14)
-    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
-    at Module.load (internal/modules/cjs/loader.js:950:32)
-    at Function.Module._load (internal/modules/cjs/loader.js:790:14)
-    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)
-    at internal/main/run_main_module.js:17:47
-
-2021-07-13T12:47:15.905Z
-TypeError: Cannot read property 'tick' of undefined
-    at exportHandler (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\export.js:37:56)
-    at dbml2sql (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\index.js:19:3)
-    at Object.<anonymous> (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\__test__\dbml2sql_bin.js:5:1)
-    at Module._compile (internal/modules/cjs/loader.js:1085:14)
-    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
-    at Module.load (internal/modules/cjs/loader.js:950:32)
-    at Function.Module._load (internal/modules/cjs/loader.js:790:14)
-    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)
-    at internal/main/run_main_module.js:17:47
-
-2021-07-13T12:58:20.418Z
-TypeError: Cannot read property 'tick' of undefined
-    at exportHandler (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\export.js:37:49)
-    at dbml2sql (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\index.js:19:3)
-    at Object.<anonymous> (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\__test__\dbml2sql_bin.js:5:1)
-    at Module._compile (internal/modules/cjs/loader.js:1085:14)
-    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
-    at Module.load (internal/modules/cjs/loader.js:950:32)
-    at Function.Module._load (internal/modules/cjs/loader.js:790:14)
-    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)
-    at internal/main/run_main_module.js:17:47
-

package/__test__/dbml2sql/filename --mysql --out-file/out-files/schema.sql

@@ -1,65 +0,0 @@
--- SQL dump generated using DBML (dbml.dbdiagram.io)
--- Database: MySQL
--- Generated at: 2024-08-12T11:56:40.986Z
-
-CREATE TABLE `orders` (
-  `id` int PRIMARY KEY AUTO_INCREMENT,
-  `user_id` int UNIQUE NOT NULL,
-  `status` ENUM ('created', 'running', 'done', 'failure'),
-  `created_at` varchar(255)
-);
-
-CREATE TABLE `order_items` (
-  `order_id` int,
-  `product_id` int,
-  `quantity` int DEFAULT 1
-);
-
-CREATE TABLE `products` (
-  `id` int PRIMARY KEY,
-  `name` varchar(255),
-  `merchant_id` int NOT NULL,
-  `price` int,
-  `status` ENUM ('Out of Stock', 'In Stock'),
-  `created_at` datetime DEFAULT (now())
-);
-
-CREATE TABLE `users` (
-  `id` int PRIMARY KEY,
-  `full_name` varchar(255),
-  `email` varchar(255) UNIQUE,
-  `gender` varchar(255),
-  `date_of_birth` varchar(255),
-  `created_at` varchar(255),
-  `country_code` int
-);
-
-CREATE TABLE `merchants` (
-  `id` int PRIMARY KEY,
-  `merchant_name` varchar(255),
-  `country_code` int,
-  `created_at` varchar(255),
-  `admin_id` int
-);
-
-CREATE TABLE `countries` (
-  `code` int PRIMARY KEY,
-  `name` varchar(255),
-  `continent_name` varchar(255)
-);
-
-CREATE INDEX `product_status` ON `products` (`merchant_id`, `status`);
-
-CREATE UNIQUE INDEX `products_index_1` ON `products` (`id`) USING HASH;
-
-ALTER TABLE `order_items` ADD FOREIGN KEY (`order_id`) REFERENCES `orders` (`id`);
-
-ALTER TABLE `order_items` ADD FOREIGN KEY (`product_id`) REFERENCES `products` (`id`);
-
-ALTER TABLE `users` ADD FOREIGN KEY (`country_code`) REFERENCES `countries` (`code`);
-
-ALTER TABLE `merchants` ADD FOREIGN KEY (`country_code`) REFERENCES `countries` (`code`);
-
-ALTER TABLE `products` ADD FOREIGN KEY (`merchant_id`) REFERENCES `merchants` (`id`);
-
-ALTER TABLE `merchants` ADD FOREIGN KEY (`admin_id`) REFERENCES `users` (`id`);

package/__test__/dbml2sql/filename --oracle --out-file/out-files/schema.sql

@@ -1,61 +0,0 @@
--- SQL dump generated using DBML (dbml.dbdiagram.io)
--- Database: Oracle
--- Generated at: 2024-08-12T11:56:41.926Z
-
-CREATE TABLE "orders" (
-  "id" int GENERATED AS IDENTITY PRIMARY KEY,
-  "user_id" int UNIQUE NOT NULL,
-  "status" nvarchar2(255) NOT NULL CHECK ("status" IN ('created', 'running', 'done', 'failure'))
-);
-
-CREATE TABLE "order_items" (
-  "order_id" int,
-  "product_id" int,
-  "quantity" int DEFAULT 1
-);
-
-CREATE TABLE "products" (
-  "id" int PRIMARY KEY,
-  "name" nvarchar2(255),
-  "merchant_id" int NOT NULL,
-  "price" int,
-  "status" nvarchar2(255) NOT NULL CHECK ("status" IN ('Out of Stock', 'In Stock')),
-  "created_at" timestamp DEFAULT current_timestamp
-);
-
-CREATE TABLE "users" (
-  "id" int PRIMARY KEY,
-  "full_name" nvarchar2(255),
-  "email" nvarchar2(255) UNIQUE,
-  "gender" nvarchar2(255),
-  "date_of_birth" date,
-  "created_at" timestamp,
-  "country_code" int
-);
-
-CREATE TABLE "merchants" (
-  "id" int PRIMARY KEY,
-  "merchant_name" nvarchar2(255),
-  "country_code" int,
-  "created_at" timestamp,
-  "admin_id" int
-);
-
-CREATE TABLE "countries" (
-  "code" int PRIMARY KEY,
-  "name" nvarchar2(255)
-);
-
-CREATE INDEX "product_status" ON "products" ("merchant_id", "status");
-
-ALTER TABLE "order_items" ADD FOREIGN KEY ("order_id") REFERENCES "orders" ("id");
-
-ALTER TABLE "order_items" ADD FOREIGN KEY ("product_id") REFERENCES "products" ("id");
-
-ALTER TABLE "users" ADD FOREIGN KEY ("country_code") REFERENCES "countries" ("code");
-
-ALTER TABLE "merchants" ADD FOREIGN KEY ("country_code") REFERENCES "countries" ("code");
-
-ALTER TABLE "products" ADD FOREIGN KEY ("merchant_id") REFERENCES "merchants" ("id");
-
-ALTER TABLE "merchants" ADD FOREIGN KEY ("admin_id") REFERENCES "users" ("id");

package/__test__/dbml2sql/filename --out-file/dbml-error.log

@@ -1,36 +0,0 @@
-2021-07-13T12:37:43.283Z
-TypeError: Cannot read property 'tick' of undefined
-    at exportHandler (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\export.js:37:56)
-    at dbml2sql (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\index.js:19:3)
-    at Object.<anonymous> (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\__test__\dbml2sql_bin.js:5:1)
-    at Module._compile (internal/modules/cjs/loader.js:1085:14)
-    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
-    at Module.load (internal/modules/cjs/loader.js:950:32)
-    at Function.Module._load (internal/modules/cjs/loader.js:790:14)
-    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)
-    at internal/main/run_main_module.js:17:47
-
-2021-07-13T12:47:19.039Z
-TypeError: Cannot read property 'tick' of undefined
-    at exportHandler (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\export.js:37:56)
-    at dbml2sql (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\index.js:19:3)
-    at Object.<anonymous> (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\__test__\dbml2sql_bin.js:5:1)
-    at Module._compile (internal/modules/cjs/loader.js:1085:14)
-    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
-    at Module.load (internal/modules/cjs/loader.js:950:32)
-    at Function.Module._load (internal/modules/cjs/loader.js:790:14)
-    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)
-    at internal/main/run_main_module.js:17:47
-
-2021-07-13T12:58:22.994Z
-TypeError: Cannot read property 'tick' of undefined
-    at exportHandler (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\export.js:37:49)
-    at dbml2sql (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\src\cli\index.js:19:3)
-    at Object.<anonymous> (C:\Users\Inspiron101\Desktop\Holistics\dbml\packages\dbml-cli\__test__\dbml2sql_bin.js:5:1)
-    at Module._compile (internal/modules/cjs/loader.js:1085:14)
-    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
-    at Module.load (internal/modules/cjs/loader.js:950:32)
-    at Function.Module._load (internal/modules/cjs/loader.js:790:14)
-    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)
-    at internal/main/run_main_module.js:17:47
-