@dbml/cli 3.6.2 → 3.7.1

package/lib/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "db2dbml", {
+  enumerable: true,
+  get: function () {
+    return _cli.db2dbml;
+  }
+});
 Object.defineProperty(exports, "dbml2sql", {
   enumerable: true,
   get: function () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbml/cli",
-  "version": "3.6.2",
+  "version": "3.7.1",
   "description": "",
   "main": "lib/index.js",
   "license": "Apache-2.0",
@@ -14,7 +14,8 @@
   },
   "bin": {
     "dbml2sql": "bin/dbml2sql.js",
-    "sql2dbml": "bin/sql2dbml.js"
+    "sql2dbml": "bin/sql2dbml.js",
+    "db2dbml": "bin/db2dbml.js"
   },
   "author": "Holistics <dev@holistics.io>",
   "homepage": "https://dbml.dbdiagram.io",
@@ -25,7 +26,7 @@
   ],
   "dependencies": {
     "@babel/cli": "^7.21.0",
-    "@dbml/core": "^3.6.2",
+    "@dbml/core": "^3.7.1",
     "bluebird": "^3.5.5",
     "chalk": "^2.4.2",
     "commander": "^2.20.0",
@@ -53,5 +54,8 @@
       "^.+\\.js$": "babel-jest"
     }
   },
-  "gitHead": "d3d82a3e8260f733098edc5fbfdbd3f8a381c6e3"
+  "gitHead": "71d7e2cd00ba5d60d2e36c465d43ce1d91189274",
+  "engines": {
+    "node": ">=18"
+  }
 }

package/src/cli/connector.js

@@ -0,0 +1,31 @@
+import { importer } from '@dbml/core';
+import figures from 'figures';
+import chalk from 'chalk';
+import path from 'path';
+import {
+  resolvePaths,
+  getConnectionOpt,
+} from './utils';
+import OutputConsolePlugin from './outputPlugins/outputConsolePlugin';
+import OutputFilePlugin from './outputPlugins/outputFilePlugin';
+import logger from '../helpers/logger';
+
+export default async function connectionHandler (program) {
+  try {
+    const { connection, format } = getConnectionOpt(program.args);
+    const opts = program.opts();
+
+    if (!opts.outFile && !opts.outDir) {
+      const res = await importer.generateDbml(connection, format);
+      OutputConsolePlugin.write(res);
+    } else if (opts.outFile) {
+      const res = await importer.generateDbml(connection, format);
+      (new OutputFilePlugin(resolvePaths(opts.outFile))).write(res);
+
+      // bearer:disable javascript_lang_logger
+      console.log(`  ${chalk.green(figures.main.tick)} Generated DBML file from database's connection: ${path.basename(opts.outFile)}`);
+    }
+  } catch (error) {
+    logger.error(error);
+  }
+}

package/src/cli/index.js

@@ -1,8 +1,13 @@
 import program from 'commander';
 import importHandler from './import';
 import exportHandler from './export';
+import connectionHandler from './connector';
 import projectInfo from '../../package.json';
 
+function showHelp (args) {
+  if (args.length < 3) program.help();
+}
+
 function dbml2sql (args) {
   program.version(projectInfo.version);
 
@@ -15,6 +20,7 @@ function dbml2sql (args) {
     .option('-o, --out-file <pathspec>', 'compile all input files into a single files');
   // .option('-d, --out-dir <pathspec>', 'compile an input directory of dbml files into an output directory');
 
+  showHelp(args);
   program.parse(args);
 
   exportHandler(program);
@@ -34,12 +40,41 @@ function sql2dbml (args) {
     .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);
   program.parse(args);
 
   importHandler(program);
 }
 
+function db2dbml (args) {
+  program.version(projectInfo.version);
+
+  // Q: How to write the arguments description for the below usage?
+  // A: The usage description is written in the following way:
+  //    - <format> your database format (postgres, mysql, mssql)
+  //    - <connection-string> your database connection string
+  //    - postgres: postgresql://user:password@localhost:5432/dbname
+  //    - mssql: 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate
+  const description = `
+    <format> your database format (postgres, mysql, mssql)
+    <connection-string> your database connection string:
+      - postgres: postgresql://user:password@localhost:5432/dbname
+      - mysql: mysql://user:password@localhost:3306/dbname
+      - mssql: 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;'
+  `;
+  program
+    .usage('<format> <connection-string> [options]')
+    .description(description)
+    .option('-o, --out-file <pathspec>', 'compile all input files into a single files');
+
+  showHelp(args);
+  program.parse(args);
+
+  connectionHandler(program);
+}
+
 export {
   dbml2sql,
   sql2dbml,
+  db2dbml,
 };

package/src/cli/utils.js

@@ -1,6 +1,7 @@
 import path from 'path';
 import fs from 'fs';
 import { CompilerError } from '@dbml/core';
+import { reduce } from 'lodash';
 
 function resolvePaths (paths) {
   if (!Array.isArray(paths)) {
@@ -32,6 +33,27 @@ function getFormatOpt (opts) {
   return format;
 }
 
+function getConnectionOpt (args) {
+  const supportedDatabases = ['postgres', 'mysql', 'mssql'];
+  const defaultConnectionOpt = {
+    connection: args[0],
+    format: 'unknown',
+  };
+
+  return reduce(args, (connectionOpt, arg) => {
+    if (supportedDatabases.includes(arg)) connectionOpt.format = arg;
+    // Check if the arg is a connection string using regex
+    const connectionStringRegex = /^.*[:;]/;
+    if (connectionStringRegex.test(arg)) {
+      // Example: jdbc:mysql://localhost:3306/mydatabase
+      // Example: odbc:Driver={SQL Server};Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
+      connectionOpt.connection = arg;
+    }
+
+    return connectionOpt;
+  }, defaultConnectionOpt);
+}
+
 function generate (inputPaths, transform, outputPlugin) {
   inputPaths.forEach((_path) => {
     const source = fs.readFileSync(_path, 'utf-8');
@@ -49,5 +71,6 @@ export {
   resolvePaths,
   validateInputFilePaths,
   getFormatOpt,
+  getConnectionOpt,
   generate,
 };

package/src/index.js

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