dbdocs 0.8.4 → 0.9.0

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.8.4","commands":{"build":{"id":"build","description":"build docs","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name","multiple":false},"public":{"name":"public","type":"boolean","description":"anyone with the URL can access","helpGroup":"sharing","allowNo":false,"exclusive":["private","password"]},"private":{"name":"private","type":"boolean","description":"only invited people can access","helpGroup":"sharing","allowNo":false,"exclusive":["public","password"]},"password":{"name":"password","type":"option","char":"p","description":"anyone with the URL + password can access","helpGroup":"sharing","multiple":false,"exclusive":["public","private"]}},"args":[{"name":"filepath","description":"dbml file path"}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name","multiple":false},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password","multiple":false},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove project","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"rename":{"id":"rename","description":"change your username","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"token":{"id":"token","description":"generate or revoke your authentication token","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"generate":{"name":"generate","type":"boolean","char":"g","description":"generate authentication token","allowNo":false},"revoke":{"name":"revoke","type":"boolean","char":"r","description":"revoke authentication token","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate docs content","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}
+{"version":"0.9.0","commands":{"build":{"id":"build","description":"build docs","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name","multiple":false},"public":{"name":"public","type":"boolean","description":"anyone with the URL can access","helpGroup":"sharing","allowNo":false,"exclusive":["private","password"]},"private":{"name":"private","type":"boolean","description":"only invited people can access","helpGroup":"sharing","allowNo":false,"exclusive":["public","password"]},"password":{"name":"password","type":"option","char":"p","description":"anyone with the URL + password can access","helpGroup":"sharing","multiple":false,"exclusive":["public","private"]}},"args":[{"name":"filepath","description":"dbml file path"}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name","multiple":false},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password","multiple":false},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove project","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"rename":{"id":"rename","description":"change your username","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"token":{"id":"token","description":"generate or revoke your authentication token","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"generate":{"name":"generate","type":"boolean","char":"g","description":"generate authentication token","allowNo":false},"revoke":{"name":"revoke","type":"boolean","char":"r","description":"revoke authentication token","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate docs content","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbdocs",
-  "version": "0.8.4",
+  "version": "0.9.0",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
@@ -9,10 +9,10 @@
     "oclif/**/ansi-regex": "^3.0.1"
   },
   "dependencies": {
-    "@dbml/core": "^2.6.0",
+    "@dbml/core": "^3.2.0",
     "@oclif/core": "1.12.1",
     "@oclif/plugin-help": "5.1.12",
-    "axios": "0.27.2",
+    "axios": "1.6.0",
     "chalk": "^3.0.0",
     "dotenv": "^8.2.0",
     "inquirer": "^7.0.1",

package/src/commands/build.js

@@ -13,7 +13,9 @@ const { shouldAskForFeedback } = require('../utils/feedback');
 const { isValidName } = require('../validators/projectName');
 const parse = require('../utils/parse');
 const { PROJECT_GENERAL_ACCESS_TYPE, FLAG_HELP_GROUP } = require('../utils/constants');
+const { getProjectUrl } = require('../utils/helper');
 const { getIsPublicValueFromBuildFlag } = require('../utils/helper');
+const { formatParserV2ErrorMessage } = require('../utils/error-formatter');
 
 async function build (project, authConfig) {
   const res = await axios.post(`${vars.apiUrl}/projects`, project, authConfig);
@@ -61,8 +63,8 @@ class BuildCommand extends Command {
         }
         spinner.succeed('Parsing file content');
       } catch (error) {
-        if (!error.location) throw error;
-        const message = `You have syntax error in ${path.basename(filepath)} line ${error.location.start.line} column ${error.location.start.column}. ${error.message}`;
+        const rawMessage = formatParserV2ErrorMessage(error);
+        const message = rawMessage ? `You have syntax error(s) in ${path.basename(filepath)}\n${rawMessage}` : 'Something wrong :( Please try again.';
         throw new Error(message);
       }
 
@@ -106,7 +108,7 @@ class BuildCommand extends Command {
           default:
             break;
         }
-        spinner.succeed(`Done. Visit: ${chalk.cyan(`${vars.hostUrl}/${newProject.org.name}/${newProject.urlName}`)}\n`);
+        spinner.succeed(`Done. Visit: ${chalk.cyan(getProjectUrl(vars.hostUrl, newProject.org.name, newProject.urlName))}\n`);
         if (shouldAskForFeedback()) {
           spinner.info(`Thanks for using dbdocs! We'd love to hear your feedback: ${chalk.cyan('https://form.jotform.com/200962053361448')}`);
         }
@@ -115,7 +117,7 @@ class BuildCommand extends Command {
         if (err.response) {
           const { error } = err.response.data;
           if (error.name === 'SyntaxError') {
-            message = `You have syntax error in ${path.basename(filepath)} line ${error.location.start.line} column ${error.location.start.column}. ${error.message}`;
+            message = `You have syntax error(s) in ${path.basename(filepath)} line ${error.location.start.line} column ${error.location.start.column}. ${error.message}`;
           } else if (error.name === 'AccessDenied') {
             message = error.message;
           }

package/src/commands/ls.js

@@ -5,6 +5,7 @@ const verifyToken = require('../utils/verifyToken');
 const { getProjectsByOrg } = require('../utils/org');
 const { getOrg } = require('../utils/org');
 const { PROJECT_SHARING_TEXT } = require('../utils/constants');
+const { getProjectUrl } = require('../utils/helper');
 
 class LsCommand extends Command {
   async run () {
@@ -15,7 +16,7 @@ class LsCommand extends Command {
       this.log(chalk.bold(org.name));
 
       const [maxUrlWidth, maxUpdatedAtWidth] = projects.reduce((accumulator, project) => {
-        const url = `${vars.hostUrl}/${org.name}/${project.urlName}`;
+        const url = getProjectUrl(vars.hostUrl, org.name, project.urlName);
         const updatedAt = (new Date(project.updatedAt)).toLocaleString();
         return [
           accumulator[0] > url.length ? accumulator[0] : url.length,
@@ -33,7 +34,7 @@ class LsCommand extends Command {
         },
         url: {
           minWidth: maxUrlWidth + 2,
-          get: (project) => chalk.cyan(`${vars.hostUrl}/${org.name}/${project.urlName}`),
+          get: (project) => chalk.cyan(getProjectUrl(vars.hostUrl, org.name, project.urlName)),
         },
         updatedAt: {
           minWidth: maxUpdatedAtWidth + 2,

package/src/commands/validate.js

@@ -3,6 +3,7 @@ const fs = require('fs');
 const path = require('path');
 const ora = require('ora');
 const parse = require('../utils/parse');
+const { formatParserV2ErrorMessage } = require('../utils/error-formatter');
 
 class ValidateCommand extends Command {
   async run () {
@@ -21,13 +22,14 @@ class ValidateCommand extends Command {
       spinner.succeed('Validating file content');
       spinner.succeed('Done. Parse succeeded without errors.');
     } catch (error) {
-      let message = error.message || 'Something wrong :( Please try again.';
-      if (filepath && error.location) message = `You have syntax error in ${path.basename(filepath)} line ${error.location.start.line} column ${error.location.start.column}. ${error.message}`;
+      const rawMessage = formatParserV2ErrorMessage(error);
+      const message = rawMessage ? `You have syntax error(s) in ${path.basename(filepath)}\n${rawMessage}` : rawMessage;
+
       if (spinner.isSpinning) {
         spinner.fail(`Failed: ${message}`);
-      } else {
-        this.error(message);
+        return;
       }
+      this.error(message);
     }
   }
 }

package/src/utils/error-formatter.js

@@ -0,0 +1,25 @@
+function createSyntaxErrorMessage (line, column, msg) {
+  return `Syntax error at line ${line} column ${column}. ${msg}`;
+}
+
+function formatParserV2ErrorMessage (error) {
+  if (!Array.isArray(error)) {
+    if (!error.location) {
+      // this is a runtime error
+      return '';
+    }
+
+    return createSyntaxErrorMessage(error.location.start.line, error.location.start.column, error.message);
+  }
+
+  const messageList = [];
+  error.forEach((err) => {
+    messageList.push(createSyntaxErrorMessage(err.location.start.line, err.location.start.column, err.message));
+  });
+
+  return messageList.join('\n');
+}
+
+module.exports = {
+  formatParserV2ErrorMessage,
+};

package/src/utils/helper.js

@@ -3,7 +3,9 @@ const getIsPublicValueFromBuildFlag = (publicFlag, privateFlag, passwordFlag) =>
   if (privateFlag) return false;
   return undefined; // 'undefined' means keep the old `isPublic` state
 };
+const getProjectUrl = (hostUrl, orgName, projectUrl) => `${hostUrl}/${encodeURIComponent(orgName)}/${projectUrl}`;
 
 module.exports = {
   getIsPublicValueFromBuildFlag,
+  getProjectUrl,
 };

package/src/utils/parserWorker.js

@@ -1,14 +1,14 @@
-const { parentPort, workerData } = require("worker_threads");
-const { Parser } = require("@dbml/core");
+const { parentPort, workerData } = require('worker_threads');
+const { Parser } = require('@dbml/core');
 
 function parse (content) {
-  const databaseObject = Parser.parse(content, 'dbml');
-  const schemas = databaseObject.schemas.map((schema) => {
-    return {
-      name: schema.name,
-      tables: schema.tables.map((table) => table.name),
-    };
-  });
+  const parser = new Parser();
+  const databaseObject = parser.parse(content, 'dbmlv2');
+  const schemas = databaseObject.schemas.map((schema) => ({
+    name: schema.name,
+    tables: schema.tables.map((table) => table.name),
+  }));
+
   return {
     name: databaseObject.name,
     description: databaseObject.note,