@saltcorn/cli 1.0.0-beta.2 → 1.0.0-beta.5

package/src/commands/dev/plugin-test.js

@@ -1,4 +1,4 @@
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const path = require("path");
 const { spawnSync } = require("child_process");
 const { getState } = require("@saltcorn/data/db/state");
@@ -148,7 +148,7 @@ const testReleasedPlugin = async (pluginName, env, backupFile) => {
  */
 class PluginTestCommand extends Command {
   async run() {
-    const { flags } = this.parse(PluginTestCommand);
+    const { flags } = await this.parse(PluginTestCommand);
     const dbname = flags.database ? flags.database : "saltcorn_test";
     let env = null;
     const db = require("@saltcorn/data/db");
@@ -194,20 +194,20 @@ class PluginTestCommand extends Command {
 }
 
 PluginTestCommand.flags = {
-  directory: flags.string({
+  directory: Flags.string({
     char: "d",
     description: "Directory of local plugin",
   }),
-  name: flags.string({
+  name: Flags.string({
     char: "n",
     description: "Plugin name in store of a released plugin",
   }),
-  backupFile: flags.string({
+  backupFile: Flags.string({
     char: "f",
     description:
       "Optional name of a backup file in the tests folder. If you ommit this, then the test has to create its own data.",
   }),
-  database: flags.string({
+  database: Flags.string({
     string: "database",
     description: "Run on specified database. Default is 'saltcorn_test''",
   }),

package/src/commands/dev/post-release.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/post-release
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 const fs = require("fs");
 const fsp = fs.promises;
 const { spawnSync, spawn } = require("child_process");
@@ -124,7 +124,7 @@ class PostReleaseCommand extends Command {
   async run() {
     const {
       args: { task },
-    } = this.parse(PostReleaseCommand);
+    } = await this.parse(PostReleaseCommand);
     this.version = require(path.join(
       __dirname,
       "..",
@@ -149,12 +149,11 @@ PostReleaseCommand.description = `Post-release tasks: docker and vagrant builds`
 /**
  * @type {object}
  */
-PostReleaseCommand.args = [
-  {
-    name: "task",
+PostReleaseCommand.args = {
+  task: Args.string({
     options: ["docker", "vagrant", "all", "none"],
     description: "What to do",
-  },
-];
+  }),
+};
 
 module.exports = PostReleaseCommand;

package/src/commands/dev/release.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/release
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 const fs = require("fs");
 const { spawnSync } = require("child_process");
 const { sleep } = require("../../common");
@@ -20,7 +20,7 @@ class ReleaseCommand extends Command {
     const {
       args: { version },
       flags,
-    } = this.parse(ReleaseCommand);
+    } = await this.parse(ReleaseCommand);
     spawnSync("git", ["pull"], {
       stdio: "inherit",
       cwd: ".",
@@ -192,12 +192,15 @@ ReleaseCommand.description = `Release a new saltcorn version`;
 /**
  * @type {object}
  */
-ReleaseCommand.args = [
-  { name: "version", required: true, description: "New version number" },
-];
+ReleaseCommand.args = {
+  version: Args.string({
+    required: true,
+    description: "New version number",
+  }),
+};
 
 ReleaseCommand.flags = {
-  tag: flags.string({
+  tag: Flags.string({
     char: "t",
     description: "NPM tag",
   }),

package/src/commands/dev/test-plugin.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/test-plugin
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 
 /**
  *
@@ -27,7 +27,7 @@ class TestPluginCommand extends Command {
     const { auto_test_plugin } = require("@saltcorn/data/plugin-testing");
     const db = require("@saltcorn/data/db");
     const { requirePlugin } = require("@saltcorn/server/load_plugins");
-    const { args } = this.parse(TestPluginCommand);
+    const { args } = await this.parse(TestPluginCommand);
     await db.changeConnection({ database: "saltcorn_test" });
     await reset();
     await fixtures();
@@ -52,9 +52,12 @@ class TestPluginCommand extends Command {
 /**
  * @type {object}
  */
-TestPluginCommand.args = [
-  { name: "path", description: "path to plugin package", required: true },
-];
+TestPluginCommand.args = {
+  path: Args.string({
+    required: true,
+    description: "path to plugin package",
+  }),
+};
 
 /**
  * @type {string}

package/src/commands/fixtures.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/fixtures
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const { maybe_as_tenant, parseJSONorString } = require("../common");
 /**
  * FixturesCommand Class
@@ -16,7 +16,7 @@ class FixturesCommand extends Command {
   async run() {
     const fixtures = require("@saltcorn/data/db/fixtures");
     const reset = require("@saltcorn/data/db/reset_schema");
-    const { flags } = this.parse(FixturesCommand);
+    const { flags } = await this.parse(FixturesCommand);
     if (flags.tenant) {
       const { loadAllPlugins } = require("@saltcorn/server/load_plugins");
       const { init_multi_tenant } = require("@saltcorn/data/db/state");
@@ -48,8 +48,8 @@ This manual step it is never required for users and rarely required for develope
  * @type {object}
  */
 FixturesCommand.flags = {
-  reset: flags.boolean({ char: "r", description: "Also reset schema" }),
-  tenant: flags.string({
+  reset: Flags.boolean({ char: "r", description: "Also reset schema" }),
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),

package/src/commands/get-cfg.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/set-cfg
  */
-const { Command, flags } = require("@oclif/command");
-const { cli } = require("cli-ux");
+const { Command, Flags, Args, ux } = require("@oclif/core");
 const { maybe_as_tenant, init_some_tenants } = require("../common");
 
 /**
@@ -11,12 +10,12 @@ const { maybe_as_tenant, init_some_tenants } = require("../common");
  * @extends oclif.Command
  * @category saltcorn-cli
  */
-class SetCfgCommand extends Command {
+class GetCfgCommand extends Command {
   /**
    * @returns {Promise<void>}
    */
   async run() {
-    const { args, flags } = this.parse(SetCfgCommand);
+    const { args, flags } = await this.parse(GetCfgCommand);
     await init_some_tenants(flags.tenant);
 
     await maybe_as_tenant(flags.tenant, async () => {
@@ -49,27 +48,30 @@ class SetCfgCommand extends Command {
 /**
  * @type {string}
  */
-SetCfgCommand.description = `Get a configuration value. The value is printed to stdout as a JSON value`;
+GetCfgCommand.description = `Get a configuration value. The value is printed to stdout as a JSON value`;
 
 /**
  * @type {object[]}
  */
-SetCfgCommand.args = [
-  { name: "key", required: false, description: "Configuration key" },
-];
+GetCfgCommand.args = {
+  key: Args.string({
+    required: false,
+    description: "Configuration key",
+  }),
+};
 
 /**
  * @type {object}
  */
-SetCfgCommand.flags = {
-  tenant: flags.string({
+GetCfgCommand.flags = {
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
-  plugin: flags.string({
+  plugin: Flags.string({
     char: "p",
     description: "plugin",
   }),
 };
 
-module.exports = SetCfgCommand;
+module.exports = GetCfgCommand;

package/src/commands/info.js

@@ -2,14 +2,13 @@
  * @category saltcorn-cli
  * @module commands/info
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const {
   configFilePath,
   getConnectObject,
 } = require("@saltcorn/data/db/connect");
 const packagejson = require("../../package.json");
-const {print_it} = require("../common");
-
+const { print_it } = require("../common");
 
 /**
  * InfoCommand Class
@@ -26,7 +25,7 @@ class InfoCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags } = this.parse(InfoCommand);
+    const { flags } = await this.parse(InfoCommand);
     const db = require("@saltcorn/data/db");
     const cliPath = __dirname;
     const conn = getConnectObject();
@@ -45,9 +44,10 @@ class InfoCommand extends Command {
       res.connectionError = e.message;
     }
     res.environmentVariables = {};
-    const envVars = "DATABASE_URL SQLITE_FILEPATH PGDATABASE PGUSER PGHOST PGPORT PGPASSWORD PGDATABASE SALTCORN_SESSION_SECRET SALTCORN_MULTI_TENANT SALTCORN_FILE_STORE SALTCORN_DEFAULT_SCHEMA SALTCORN_FIXED_CONFIGURATION SALTCORN_INHERIT_CONFIGURATION SALTCORN_SERVE_ADDITIONAL_DIR SALTCORN_NWORKERS SALTCORN_DISABLE_UPGRADE PUPPETEER_CHROMIUM_BIN".split(
-      " "
-    );
+    const envVars =
+      "DATABASE_URL SQLITE_FILEPATH PGDATABASE PGUSER PGHOST PGPORT PGPASSWORD PGDATABASE SALTCORN_SESSION_SECRET SALTCORN_MULTI_TENANT SALTCORN_FILE_STORE SALTCORN_DEFAULT_SCHEMA SALTCORN_FIXED_CONFIGURATION SALTCORN_INHERIT_CONFIGURATION SALTCORN_SERVE_ADDITIONAL_DIR SALTCORN_NWORKERS SALTCORN_DISABLE_UPGRADE PUPPETEER_CHROMIUM_BIN".split(
+        " "
+      );
     envVars.forEach((v) => {
       if (process.env[v]) res.environmentVariables[v] = process.env[v];
       else res.environmentVariables[v] = "";
@@ -69,7 +69,7 @@ Show configuration and file store paths
  * @type {object}
  */
 InfoCommand.flags = {
-  json: flags.boolean({ char: "j", description: "json format" }),
+  json: Flags.boolean({ char: "j", description: "json format" }),
 };
 
 module.exports = InfoCommand;

package/src/commands/inspect.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/create-user
  */
-const { Command, flags } = require("@oclif/command");
-const { cli } = require("cli-ux");
+const { Command, Flags, Args, ux } = require("@oclif/core");
 const { maybe_as_tenant, init_some_tenants } = require("../common");
 
 // todo update logic based on modify-user command
@@ -19,7 +18,7 @@ class InspectCommand extends Command {
   async run() {
     const User = require("@saltcorn/data/models/user");
 
-    const { flags, args } = this.parse(InspectCommand);
+    const { flags, args } = await this.parse(InspectCommand);
 
     // init tenant
     await init_some_tenants(flags.tenant);
@@ -53,23 +52,21 @@ InspectCommand.description = `Inspect an entity's JSON representation, or list e
  * @type {object}
  */
 InspectCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
 };
 
-InspectCommand.args = [
-  {
-    name: "type",
+InspectCommand.args = {
+  type: Args.string({
     required: true,
     description: "Entity type",
     options: ["view", "page", "trigger", "table"],
-  },
-  {
-    name: "name",
+  }),
+  name: Args.string({
     description: "Entity name. If not supplied, list all names",
-  },
-];
+  }),
+};
 
 module.exports = InspectCommand;

package/src/commands/install-pack.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/install-pack
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const { maybe_as_tenant } = require("../common");
 const fs = require("fs");
 
@@ -16,7 +16,7 @@ class InstallPackCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags } = this.parse(InstallPackCommand);
+    const { flags } = await this.parse(InstallPackCommand);
     const {
       fetch_pack_by_name,
       install_pack,
@@ -72,15 +72,15 @@ InstallPackCommand.description = `Install a pack or restore a snapshot`;
  * @type {object}
  */
 InstallPackCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
-  name: flags.string({
+  name: Flags.string({
     char: "n",
     description: "Pack name in store",
   }),
-  file: flags.string({
+  file: Flags.string({
     char: "f",
     description: "File with pack JSON",
   }),

package/src/commands/install-plugin.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/install-plugin
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const { maybe_as_tenant, init_some_tenants } = require("../common");
 const fs = require("fs");
 const path = require("path");
@@ -17,7 +17,7 @@ class InstallPluginCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags } = this.parse(InstallPluginCommand);
+    const { flags } = await this.parse(InstallPluginCommand);
     const {
       fetch_pack_by_name,
       install_pack,
@@ -84,19 +84,19 @@ InstallPluginCommand.description = `Install a plugin`;
  * @type {object}
  */
 InstallPluginCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
-  name: flags.string({
+  name: Flags.string({
     char: "n",
     description: "Plugin name in store",
   }),
-  directory: flags.string({
+  directory: Flags.string({
     char: "d",
     description: "Directory with local plugin",
   }),
-  unsafe: flags.boolean({
+  unsafe: Flags.boolean({
     char: "u",
     description: "Allow unsafe plugins on tenants",
   }),

package/src/commands/list-tenants.js

@@ -2,10 +2,9 @@
  * @category saltcorn-cli
  * @module commands/list-tenants
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const db = require("@saltcorn/data/db");
-const {print_table} = require("../common");
-
+const { print_table } = require("../common");
 
 /**
  * ListTenantsCommand Class
@@ -17,19 +16,18 @@ class ListTenantsCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const {flags, args} = this.parse(ListTenantsCommand);
+    const { flags, args } = await this.parse(ListTenantsCommand);
 
     const { getAllTenants } = require("@saltcorn/admin-models/models/tenant");
-    let tenantList = flags.tenant? [flags.tenant] : await getAllTenants();
+    let tenantList = flags.tenant ? [flags.tenant] : await getAllTenants();
 
     let tenantDetails = new Object();
 
-    let index=0;
+    let index = 0;
     for (const domain of tenantList) {
       index++;
       await db.runWithTenant(domain, async () => {
-        if (!flags.verbose)
-          tenantDetails[index] = { domain : domain };
+        if (!flags.verbose) tenantDetails[index] = { domain: domain };
         else
           tenantDetails[index] = {
             domain: domain,
@@ -40,18 +38,29 @@ class ListTenantsCommand extends Command {
             pages: await db.count("_sc_pages"),
             files: await db.count("_sc_files"),
             triggers: await db.count("_sc_triggers"),
-            tags: await  db.count ("_sc_tags"),
-          }
+            tags: await db.count("_sc_tags"),
+          };
       });
     }
 
     // print
-    if(!flags.verbose)
-      print_table(tenantDetails,["domain"],flags.json);
+    if (!flags.verbose) print_table(tenantDetails, ["domain"], flags.json);
     else
-      print_table(tenantDetails,
-        ["domain","users","roles","tables","views","pages", "files","triggers", "tags"],
-        flags.json);
+      print_table(
+        tenantDetails,
+        [
+          "domain",
+          "users",
+          "roles",
+          "tables",
+          "views",
+          "pages",
+          "files",
+          "triggers",
+          "tags",
+        ],
+        flags.json
+      );
     this.exit(0);
   }
 }
@@ -67,24 +76,23 @@ ListTenantsCommand.description = `List tenants in CSV format`;
  */
 ListTenantsCommand.help = "Extra help here";
 
-
 /**
  * @type {object}
  */
 ListTenantsCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     name: "tenant",
     char: "t",
     description: "tenant",
     required: false,
   }),
-  verbose: flags.boolean({
+  verbose: Flags.boolean({
     name: "verbose",
     char: "v",
     description: "verbose output",
     required: false,
   }),
-  json: flags.boolean({ char: "j", description: "json format" }),
+  json: Flags.boolean({ char: "j", description: "json format" }),
 };
 
 module.exports = ListTenantsCommand;

package/src/commands/list-triggers.js

@@ -2,9 +2,12 @@
  * @category saltcorn-cli
  * @module commands/run-trigger
  */
-const { Command, flags } = require("@oclif/command");
-const { cli } = require("cli-ux");
-const { maybe_as_tenant, init_some_tenants, print_table} = require("../common");
+const { Command, Flags, ux } = require("@oclif/core");
+const {
+  maybe_as_tenant,
+  init_some_tenants,
+  print_table,
+} = require("../common");
 
 /**
  * ListTriggerCommand Class
@@ -16,10 +19,10 @@ class ListTriggersCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const {flags, args} = this.parse(ListTriggersCommand);
+    const { flags, args } = await this.parse(ListTriggersCommand);
     await init_some_tenants(flags.tenant);
 
-    const {mockReqRes} = require("@saltcorn/data/tests/mocks");
+    const { mockReqRes } = require("@saltcorn/data/tests/mocks");
     const Trigger = require(`@saltcorn/data/models/trigger`);
     //const that = this;
     await maybe_as_tenant(flags.tenant, async () => {
@@ -28,16 +31,25 @@ class ListTriggersCommand extends Command {
         console.log(`There are no triggers`);
         this.exit(1);
       }
-      if(!flags.verbose){
-        print_table(triggers,["name"], flags.json);
+      if (!flags.verbose) {
+        print_table(triggers, ["name"], flags.json);
+      } else {
+        print_table(
+          triggers,
+          [
+            "id",
+            "name",
+            "action",
+            "when_trigger",
+            "min_role",
+            "channel",
+            "table_id",
+            "table_name",
+            "description",
+          ],
+          flags.json
+        );
       }
-      else {
-        print_table(triggers,
-          ["id","name","action","when_trigger","min_role",
-            "channel","table_id","table_name","description"],
-          flags.json);
-      }
-
     });
     this.exit(0);
   }
@@ -47,24 +59,23 @@ class ListTriggersCommand extends Command {
  */
 ListTriggersCommand.description = `List triggers`;
 
-
 /**
  * @type {object}
  */
 ListTriggersCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     name: "tenant",
     char: "t",
     description: "tenant",
     required: false,
   }),
-  verbose: flags.boolean({
+  verbose: Flags.boolean({
     name: "verbose",
     char: "v",
     description: "verbose output",
     required: false,
   }),
-  json: flags.boolean({ char: "j", description: "json format" }),
+  json: Flags.boolean({ char: "j", description: "json format" }),
 };
 
 module.exports = ListTriggersCommand;

package/src/commands/list-users.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/run-trigger
  */
-const { Command, flags } = require("@oclif/command");
-const { cli } = require("cli-ux");
+const { Command, Flags, ux } = require("@oclif/core");
 const { maybe_as_tenant, init_some_tenants } = require("../common");
 
 /**
@@ -16,10 +15,10 @@ class ListUsersCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const {flags, args} = this.parse(ListUsersCommand);
+    const { flags, args } = await this.parse(ListUsersCommand);
     await init_some_tenants(flags.tenant);
 
-    const {mockReqRes} = require("@saltcorn/data/tests/mocks");
+    const { mockReqRes } = require("@saltcorn/data/tests/mocks");
     const User = require(`@saltcorn/data/models/user`);
     //const that = this;
     await maybe_as_tenant(flags.tenant, async () => {
@@ -29,17 +28,11 @@ class ListUsersCommand extends Command {
         this.exit(1);
       }
 
-      if(!flags.verbose){
-        console.table(users,
-          ["email"]
-        );
+      if (!flags.verbose) {
+        console.table(users, ["email"]);
+      } else {
+        console.table(users, ["id", "email", "language", "role_id"]);
       }
-      else {
-        console.table(users,
-          ["id","email","language","role_id"]
-        );
-      }
-
     });
     this.exit(0);
   }
@@ -57,13 +50,13 @@ ListUsersCommand.help = `List users`;
  * @type {object}
  */
 ListUsersCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     name: "tenant",
     char: "t",
     description: "tenant",
     required: false,
   }),
-  verbose: flags.boolean({
+  verbose: Flags.boolean({
     name: "verbose",
     char: "v",
     description: "verbose output",

package/src/commands/migrate.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/migrate
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const db = require("@saltcorn/data/db");
 const { eachTenant } = require("@saltcorn/admin-models/models/tenant");
 // todo add dryrun mode