dbdocs 0.8.1 → 0.8.3

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.8.1","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.8.3","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.1",
+  "version": "0.8.3",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
@@ -9,7 +9,7 @@
     "oclif/**/ansi-regex": "^3.0.1"
   },
   "dependencies": {
-    "@dbml/core": "^2.5.3",
+    "@dbml/core": "^2.6.0",
     "@oclif/core": "1.12.1",
     "@oclif/plugin-help": "5.1.12",
     "axios": "0.27.2",
@@ -19,6 +19,7 @@
     "netrc-parser": "^3.1.6",
     "open": "^7.0.0",
     "ora": "^4.0.3",
+    "remove-markdown": "^0.5.0",
     "update-notifier": "^6.0.2"
   },
   "devDependencies": {

package/src/commands/build.js

@@ -5,6 +5,7 @@ const fs = require('fs');
 const path = require('path');
 const ora = require('ora');
 const chalk = require('chalk');
+const removeMd = require('remove-markdown');
 const { vars } = require('../vars');
 const verifyToken = require('../utils/verifyToken');
 const { getOrg } = require('../utils/org');
@@ -83,6 +84,7 @@ class BuildCommand extends Command {
         const isPublic = getIsPublicValueFromBuildFlag(publicFlag, privateFlag, password);
         const { newProject } = await build({
           projectName: project,
+          description: removeMd(model.description),
           isPublic,
           password,
           orgName: org,

package/src/commands/login.js

@@ -7,6 +7,7 @@ const netrc = require('netrc-parser').default;
 const { vars } = require('../vars');
 const { isValidEmail } = require('../validators/email');
 const { isValidOtp } = require('../validators/otp');
+const { LOGIN_METHODS } = require('../utils/constants');
 
 async function askForOtp (spinner, shortLivedToken, email) {
   const cliSpinner = spinner;
@@ -77,8 +78,8 @@ class LoginCommand extends Command {
           type: 'rawlist',
           message: 'Choose a login method:',
           choices: [
-            { name: 'Email', value: 'Email' },
-            { name: 'GitHub', value: 'GitHub' },
+            { name: 'Email', value: LOGIN_METHODS.EMAIL },
+            { name: 'GitHub/Google', value: LOGIN_METHODS.GITHUB_GOOGLE },
           ],
           name: 'loginMethod',
         },
@@ -86,14 +87,9 @@ class LoginCommand extends Command {
 
       const { loginMethod } = loginMethodAnswer;
 
-      const loginMethods = {
-        EMAIL: 'Email',
-        GITHUB: 'GitHub',
-      };
-
       let authToken;
 
-      if (loginMethod === loginMethods.EMAIL) {
+      if (loginMethod === LOGIN_METHODS.EMAIL) {
         authToken = await loginViaEmail(spinner);
       } else {
         await open(`${vars.hostUrl}/login/cli`, { wait: false });

package/src/utils/constants.js

@@ -14,8 +14,14 @@ const FLAG_HELP_GROUP = {
   sharing: 'sharing',
 };
 
+const LOGIN_METHODS = {
+  EMAIL: 'Email',
+  GITHUB_GOOGLE: 'GitHub/Google',
+};
+
 module.exports = {
   PROJECT_GENERAL_ACCESS_TYPE,
   PROJECT_SHARING_TEXT,
   FLAG_HELP_GROUP,
+  LOGIN_METHODS,
 };

package/src/utils/parserWorker.js

@@ -11,6 +11,7 @@ function parse (content) {
   });
   return {
     name: databaseObject.name,
+    description: databaseObject.note,
     schemas,
   };
 }