dbdocs 0.6.0 → 0.6.3

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g dbdocs
 $ dbdocs COMMAND
 running command...
 $ dbdocs (-v|--version|version)
-dbdocs/0.6.0 darwin-x64 node-v15.10.0
+dbdocs/0.6.2 darwin-x64 node-v15.10.0
 $ dbdocs --help [COMMAND]
 USAGE
   $ dbdocs COMMAND
@@ -36,6 +36,7 @@ USAGE
 * [`dbdocs password`](#dbdocs-password)
 * [`dbdocs remove [PROJECT_NAME]`](#dbdocs-remove-project_name)
 * [`dbdocs token`](#dbdocs-token)
+* [`dbdocs validate [FILEPATH]`](#dbdocs-validate-filepath)
 
 ## `dbdocs build [FILEPATH]`
 
@@ -141,4 +142,16 @@ OPTIONS
   -g, --generate  generate authentication token
   -r, --revoke    revoke authentication token
 ```
+
+## `dbdocs validate [FILEPATH]`
+
+validate docs content
+
+```
+USAGE
+  $ dbdocs validate [FILEPATH]
+
+ARGUMENTS
+  FILEPATH  dbml file path
+```
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.6.0","commands":{"build":{"id":"build","description":"build docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name"},"password":{"name":"password","type":"option","char":"p","description":"password for project"}},"args":[{"name":"filepath","description":"dbml file path"}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name"},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password"},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"token":{"id":"token","description":"generate or revoke your authentication token","pluginName":"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":[]}}}
+{"version":"0.6.3","commands":{"build":{"id":"build","description":"build docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name"},"password":{"name":"password","type":"option","char":"p","description":"password for project"}},"args":[{"name":"filepath","description":"dbml file path"}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name"},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password"},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"token":{"id":"token","description":"generate or revoke your authentication token","pluginName":"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","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "dbdocs",
-  "version": "0.6.0",
+  "version": "0.6.3",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
   },
   "dependencies": {
+    "@dbml/core": "^2.4.2",
     "@oclif/command": "^1",
     "@oclif/config": "^1",
     "@oclif/plugin-help": "^2",
@@ -51,6 +52,9 @@
       "init": [
         "./src/hooks/init/checkUpdate",
         "./src/hooks/init/loadEnv"
+      ],
+      "prerun":[
+        "./src/hooks/prerun/checkVersion"
       ]
     }
   },

package/src/commands/build.js

@@ -10,14 +10,7 @@ const verifyToken = require('../utils/verifyToken');
 const { getOrg } = require('../utils/org');
 const { shouldAskForFeedback } = require('../utils/feedback');
 const { isValidName } = require('../validators/projectName');
-
-async function validate (content) {
-  const res = await axios.post(`${vars.apiUrl}/parse`, {
-    content,
-  });
-
-  return res.data.model;
-}
+const parse = require('../utils/parse');
 
 async function build (project, authConfig) {
   const res = await axios.post(`${vars.apiUrl}/projects`, project, authConfig);
@@ -57,20 +50,16 @@ class BuildCommand extends Command {
       // validate dbml syntax, get project name if it's already defined in the file
       spinner.text = 'Parsing file content';
       spinner.start();
+      let model = null;
       try {
-        const model = await validate(content);
+        model = await parse(content);
         if (!project) {
-          project = model.database['1'].name;
+          project = model.name;
         }
         spinner.succeed('Parsing file content');
-      } catch (err) {
-        let message = err.message || 'Something wrong :( Please try again.';
-        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}`;
-          }
-        }
+      } 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}`;
         throw new Error(message);
       }
 
@@ -95,6 +84,7 @@ class BuildCommand extends Command {
           doc: {
             content,
           },
+          shallowSchema: model.schemas,
         }, authConfig);
         if (!newProject.isPublic) {
           if (isCreated || password) {

package/src/commands/ls.js

@@ -15,7 +15,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.name}`;
+        const url = `${vars.hostUrl}/${org.name}/${project.urlName}`;
         const updatedAt = (new Date(project.updatedAt)).toLocaleString();
         return [
           accumulator[0] > url.length ? accumulator[0] : url.length,
@@ -35,7 +35,7 @@ class LsCommand extends Command {
         },
         url: {
           minWidth: maxUrlWidth + 2,
-          get: (project) => chalk.cyan(`${vars.hostUrl}/${org.name}/${project.name}`),
+          get: (project) => chalk.cyan(`${vars.hostUrl}/${org.name}/${project.urlName}`),
         },
         updatedAt: {
           minWidth: maxUpdatedAtWidth + 2,

package/src/commands/validate.js

@@ -0,0 +1,43 @@
+const { Command, flags } = require('@oclif/command');
+const fs = require('fs');
+const path = require('path');
+const ora = require('ora');
+const parse = require('../utils/parse');
+
+class ValidateCommand extends Command {
+  async run () {
+    const spinner = ora({});
+    let filepath = null;
+    try {
+      const { args } = this.parse(ValidateCommand);
+      filepath = args.filepath;
+      let content = '';
+      content = fs.readFileSync(path.resolve(process.cwd(), filepath), 'utf-8');
+
+      spinner.text = 'Validating file content';
+      spinner.start();
+
+      await parse(content);
+      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}`;
+      if (spinner.isSpinning) {
+        spinner.fail(`Failed: ${message}`);
+      } else {
+        this.error(message);
+      }
+    }
+  }
+}
+
+ValidateCommand.description = 'validate docs content';
+
+ValidateCommand.flags = {};
+
+ValidateCommand.args = [
+  { name: 'filepath', description: 'dbml file path' },
+];
+
+module.exports = ValidateCommand;

package/src/hooks/prerun/checkVersion.js

@@ -0,0 +1,20 @@
+const { getVersion, getPackageVersion, compareVersion } = require('./helper');
+
+module.exports = async function () {
+  let shouldExit = false;
+  try {
+    const localVersion = getPackageVersion();
+    const remoteVersion = await getVersion();
+    const mustUpgrade = compareVersion(localVersion, remoteVersion.required) === -1;
+    if (mustUpgrade) {
+      shouldExit = true;
+      this.error('Your CLI version is no longer supported, please upgrade with "npm i -g dbdocs"');
+    }
+    const shouldUpgrade = compareVersion(localVersion, remoteVersion.current) === -1;
+    if (shouldUpgrade) this.warn('A new version is available, use "npm i -g dbdocs" to upgrade to the latest version');
+  } catch (err) {
+    const message = err.message || 'Something goes wrong when checking version';
+    if (shouldExit) this.error(message);
+    this.warn(message);
+  }
+};

package/src/hooks/prerun/helper.js

@@ -0,0 +1,37 @@
+const axios = require('axios');
+const { vars } = require('../../vars');
+const pkg = require('../../../package.json');
+
+const getVersion = async () => {
+  const res = await axios.get(`${vars.apiUrl}/version/cli`);
+  return res.data;
+};
+const getPackageVersion = () => {
+  const ver = pkg.version;
+  const [major, minor, patch] = ver.split('.');
+  return { major, minor, patch };
+};
+
+/**
+ * @param {{major: number, minor: number, patch: number}} a: version to compare
+ * @param {{major: number, minor: number, patch: number}} b: version to compare to
+ * @returns {number}
+ * 0: a = b;
+ * 1: a > b;
+ * -1: a < b;
+ */
+const compareVersion = (a, b) => {
+  if (a.major > b.major) return 1;
+  if (a.major < b.major) return -1;
+  if (a.minor > b.minor) return 1;
+  if (a.minor < b.minor) return -1;
+  if (a.patch > b.patch) return 1;
+  if (a.patch < b.patch) return -1;
+  return 0;
+};
+
+module.exports = {
+  getVersion,
+  getPackageVersion,
+  compareVersion,
+};

package/src/utils/parse.js

@@ -0,0 +1,18 @@
+const { Worker } = require('worker_threads');
+
+const parse = (content) => {
+  return new Promise((resolve, reject) => {
+    const workerPath = `${__dirname}/parserWorker.js`;
+
+    const worker = new Worker(workerPath, {
+      workerData: { content },
+    });
+    worker.on('message', resolve);
+    worker.on('error', reject);
+    worker.on('exit', (code) => {
+      if (code !== 0) reject(new Error(`Worker stopped with exit code ${code}`));
+    });
+  });
+};
+
+module.exports = parse;

package/src/utils/parserWorker.js

@@ -0,0 +1,20 @@
+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),
+    };
+  });
+  return {
+    name: databaseObject.name,
+    schemas,
+  };
+}
+
+const { content } = workerData;
+const result = parse(content);
+parentPort.postMessage(result);