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

package/src/commands/modify-user.js

@@ -4,8 +4,7 @@
  */
 
 // todo support for  users without emails (using user.id)
-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");
 
 /**
@@ -20,8 +19,7 @@ class ModifyUserCommand extends Command {
   async run() {
     const User = require("@saltcorn/data/models/user");
 
-    const { args } = this.parse(ModifyUserCommand);
-    const { flags } = this.parse(ModifyUserCommand);
+    const { args, flags } = await this.parse(ModifyUserCommand);
 
     if (flags.admin && flags.role && flags.role !== "admin") {
       console.error("Error: specify at most one of admin and role");
@@ -49,7 +47,7 @@ class ModifyUserCommand extends Command {
       let email;
       if (flags.email) email = flags.email;
       else if (flags.imode)
-        email = await cli.prompt("New Email address", {
+        email = await ux.prompt("New Email address", {
           default: args.user_email,
         });
       if (email === args.user_email) email = undefined; // little trick - we won't update email if it already same
@@ -64,7 +62,7 @@ class ModifyUserCommand extends Command {
       let password;
       if (flags.password) password = flags.password;
       else if (flags.imode)
-        password = await cli.prompt("New Password", { type: "hide" });
+        password = await ux.prompt("New Password", { type: "hide" });
       if (password)
         if (User.unacceptable_password_reason(password)) {
           console.error(
@@ -113,9 +111,12 @@ class ModifyUserCommand extends Command {
 /**
  * @type {object}
  */
-ModifyUserCommand.args = [
-  { name: "user_email", required: true, description: "User to modify" },
-];
+ModifyUserCommand.args = {
+  user_email: Args.string({
+    required: true,
+    description: "User to modify",
+  }),
+};
 
 /**
  * @type {string}
@@ -145,24 +146,24 @@ NOTE that -a and -r role (--role=role) can give conflict.
  * @type {object}
  */
 ModifyUserCommand.flags = {
-  admin: flags.boolean({ char: "a", description: "make user be Admin" }),
-  tenant: flags.string({
+  admin: Flags.boolean({ char: "a", description: "make user be Admin" }),
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
-  email: flags.string({
+  email: Flags.string({
     char: "e",
     description: "new email",
   }),
-  role: flags.string({
+  role: Flags.string({
     char: "r",
     description: "new role (can conflict with -a option)",
   }),
-  password: flags.string({
+  password: Flags.string({
     char: "p",
     description: "new password",
   }),
-  imode: flags.boolean({ char: "i", description: "interactive mode" }),
+  imode: Flags.boolean({ char: "i", description: "interactive mode" }),
 };
 
 module.exports = ModifyUserCommand;

package/src/commands/plugins.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/plugins
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 
 /**
  * Plugins list and update command
@@ -19,7 +19,7 @@ class PluginsCommand extends Command {
     const { getAllTenants } = require("@saltcorn/admin-models/models/tenant");
     const Plugin = require("@saltcorn/data/models/plugin");
     var plugins = [];
-    const { flags } = this.parse(PluginsCommand);
+    const { flags } = await this.parse(PluginsCommand);
 
     const tenantList = [
       db.connectObj.default_schema,
@@ -109,19 +109,19 @@ class PluginsCommand extends Command {
  */
 PluginsCommand.flags = {
   //list: flags.boolean({ char: "l", description: "List" }),
-  upgrade: flags.boolean({ char: "u", description: "Upgrade" }),
-  dryRun: flags.boolean({ char: "d", description: "Upgrade dry-run" }),
-  verbose: flags.boolean({
+  upgrade: Flags.boolean({ char: "u", description: "Upgrade" }),
+  dryRun: Flags.boolean({ char: "d", description: "Upgrade dry-run" }),
+  verbose: Flags.boolean({
     char: "v",
     description: "Verbose output",
     default: false,
   }),
-  force: flags.boolean({
+  force: Flags.boolean({
     char: "f",
     description: "Force update",
     default: false,
   }),
-  name: flags.string({
+  name: Flags.string({
     char: "n",
     description: "Plugin name",
   }),

package/src/commands/reset-schema.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/reset-schema
  */
-const { Command, flags } = require("@oclif/command");
-const { cli } = require("cli-ux");
+const { Command, Flags, ux } = require("@oclif/core");
 const { maybe_as_tenant } = require("../common");
 
 /**
@@ -18,13 +17,13 @@ class ResetCommand extends Command {
   async run() {
     const reset = require("@saltcorn/data/db/reset_schema");
     const db = require("@saltcorn/data/db");
-    const { flags } = this.parse(ResetCommand);
+    const { flags } = await this.parse(ResetCommand);
     await maybe_as_tenant(flags.tenant, async () => {
       const schema = db.getTenantSchema();
       if (flags.force) {
         await reset(false, schema);
       } else {
-        const ans = await cli.confirm(
+        const ans = await ux.confirm(
           `This will wipe all data from database "${
             db.isSQLite ? "SQLite" : db.connectObj.database + "." + schema
           }".\nContinue (y/n)?`
@@ -57,8 +56,8 @@ This will delete all existing information
  * @type {object}
  */
 ResetCommand.flags = {
-  force: flags.boolean({ char: "f", description: "force command execution" }),
-  tenant: flags.string({
+  force: Flags.boolean({ char: "f", description: "force command execution" }),
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),

package/src/commands/restore.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/restore
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 const { spawnSync } = require("child_process");
 const path = require("path");
 const { maybe_as_tenant } = require("../common");
@@ -60,7 +60,7 @@ class RestoreCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { args, flags } = this.parse(RestoreCommand);
+    const { args, flags } = await this.parse(RestoreCommand);
     switch (path.extname(args.file)) {
       case ".sqlc":
         if (flags.tenant) {
@@ -82,9 +82,9 @@ class RestoreCommand extends Command {
 /**
  * @type {object}
  */
-RestoreCommand.args = [
-  { name: "file", required: true, description: "backup file to restore" },
-];
+RestoreCommand.args = {
+  file: Args.string({ required: true, description: "backup file to restore" }),
+};
 
 /**
  * @type {string}
@@ -100,7 +100,7 @@ RestoreCommand.help = `Restore a previously backed up database (zip or sqlc form
  * @type {object}
  */
 RestoreCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),

package/src/commands/rm-tenant.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/rm-tenant
  */
-const { Command, flags } = require("@oclif/command");
-const {cli} = require("cli-ux");
+const { Command, Flags, ux } = require("@oclif/core");
 
 /**
  * RmTenantCommand Class
@@ -15,15 +14,14 @@ class RmTenantCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-
-
-    const { flags } = this.parse(RmTenantCommand);
+    const { flags } = await this.parse(RmTenantCommand);
 
     const { deleteTenant } = require("@saltcorn/admin-models/models/tenant");
 
     if (!flags.force) {
-      const ans = await cli.confirm(
-        `This will delete tenant ${flags.tenant}. Attention! All tenant data will be lost!\nContinue (y/n)?`);
+      const ans = await ux.confirm(
+        `This will delete tenant ${flags.tenant}. Attention! All tenant data will be lost!\nContinue (y/n)?`
+      );
       if (!ans) {
         console.log(`Success: Command execution canceled`);
         this.exit(1);
@@ -63,8 +61,8 @@ It recommended to make backup of tenant before perform this command.
  * @type {object}
  */
 RmTenantCommand.flags = {
-  force: flags.boolean({ char: "f", description: "force command execution" }),
-  tenant: flags.string({
+  force: Flags.boolean({ char: "f", description: "force command execution" }),
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
     required: true,

package/src/commands/run-benchmark.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/run-benchmark
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 const si = require("systeminformation");
 const fetch = require("node-fetch");
 
@@ -11,16 +11,16 @@ const { sleep } = require("../common");
 const packagejson = require("../../package.json");
 
 /**
- * 
- * @param {string} s 
+ *
+ * @param {string} s
  * @returns {number}
  */
 const parseMillisecs = (s) =>
   s.endsWith("ms") ? parseFloat(s) : parseFloat(s) * 1000;
 
 /**
- * 
- * @param {*} args 
+ *
+ * @param {*} args
  * @returns {Promise<object>}
  */
 const wrk = (args) =>
@@ -37,8 +37,8 @@ const wrk = (args) =>
   });
 
 /**
- * 
- * @param {string} s 
+ *
+ * @param {string} s
  * @returns {string}
  */
 const ensure_no_final_slash = (s) => (s.endsWith("/") ? s.slice(0, -1) : s);
@@ -56,7 +56,7 @@ class RunBenchmarkCommand extends Command {
     const {
       args: { baseurl },
       flags: { token, delay, benchmark },
-    } = this.parse(RunBenchmarkCommand);
+    } = await this.parse(RunBenchmarkCommand);
     const File = require("@saltcorn/data/models/file");
     const file = await File.findOne({ filename: "rick.png" });
     if (!file) {
@@ -138,9 +138,12 @@ class RunBenchmarkCommand extends Command {
 /**
  * @type {object}
  */
-RunBenchmarkCommand.args = [
-  { name: "baseurl", required: false, description: "Base URL" },
-];
+RunBenchmarkCommand.args = {
+  baseurl: Args.string({
+    required: false,
+    description: "Base URL",
+  }),
+};
 
 /**
  * @type {string}
@@ -151,15 +154,15 @@ RunBenchmarkCommand.description = `Run benchmark`;
  * @type {object}
  */
 RunBenchmarkCommand.flags = {
-  token: flags.string({
+  token: Flags.string({
     char: "t",
     description: "API Token for reporting results",
   }),
-  benchmark: flags.string({
+  benchmark: Flags.string({
     char: "b",
     description: "Which benchmark to run",
   }),
-  delay: flags.integer({
+  delay: Flags.integer({
     char: "d",
     description: "delay between runs (s)",
     default: 30,

package/src/commands/run-js.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/run-js
  */
-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,
@@ -24,7 +23,7 @@ class RunJSCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags, args } = this.parse(RunJSCommand);
+    const { flags, args } = await this.parse(RunJSCommand);
     await init_some_tenants(flags.tenant);
 
     const that = this;
@@ -58,17 +57,17 @@ RunJSCommand.description = `Run javascript code`;
  * @type {object}
  */
 RunJSCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     name: "tenant",
     char: "t",
     description: "tenant name",
   }),
-  code: flags.string({
+  code: Flags.string({
     name: "code",
     char: "c",
     description: "js code",
   }),
-  file: flags.string({
+  file: Flags.string({
     name: "file",
     char: "f",
     description: "path to script file",

package/src/commands/run-sql.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/run-sql
  */
-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,
@@ -21,7 +20,7 @@ class RunSQLCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags, args } = this.parse(RunSQLCommand);
+    const { flags, args } = await this.parse(RunSQLCommand);
 
     if (!flags.sql && !flags.file) {
       console.log(
@@ -79,17 +78,17 @@ RunSQLCommand.description = `Run sql expression`;
  * @type {object}
  */
 RunSQLCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     name: "tenant",
     char: "t",
     description: "tenant name",
   }),
-  sql: flags.string({
+  sql: Flags.string({
     name: "sql",
     char: "s",
     description: "sql statement",
   }),
-  file: flags.string({
+  file: Flags.string({
     name: "file",
     char: "f",
     description: "path to sql file name",

package/src/commands/run-tests.js

@@ -4,7 +4,7 @@
  * @category saltcorn-cli
  * @module commands/run-tests
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 
 const { spawnSync, spawn } = require("child_process");
 const path = require("path");
@@ -121,7 +121,7 @@ class RunTestsCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { args, flags } = this.parse(RunTestsCommand);
+    const { args, flags } = await this.parse(RunTestsCommand);
     this.validateCall(args, flags);
     let env;
 
@@ -195,9 +195,11 @@ class RunTestsCommand extends Command {
 /**
  * @type {object}
  */
-RunTestsCommand.args = [
-  { name: "package", description: "which package to run tests for" },
-];
+RunTestsCommand.args = {
+  package: Args.string({
+    description: "which package to run tests for",
+  }),
+};
 
 /**
  * @type {string}
@@ -208,27 +210,27 @@ RunTestsCommand.description = `Run test suites`;
  * @type {object}
  */
 RunTestsCommand.flags = {
-  coverage: flags.boolean({ char: "c", description: "Coverage" }),
-  listTests: flags.boolean({ char: "l", description: "List tests" }),
-  verbose: flags.boolean({ char: "v", description: "Verbose" }),
-  detectOpenHandles: flags.boolean({
+  coverage: Flags.boolean({ char: "c", description: "Coverage" }),
+  listTests: Flags.boolean({ char: "l", description: "List tests" }),
+  verbose: Flags.boolean({ char: "v", description: "Verbose" }),
+  detectOpenHandles: Flags.boolean({
     char: "d",
     description: "Detect Open Handles",
   }),
-  testFilter: flags.string({
+  testFilter: Flags.string({
     char: "t",
     description: "Filter tests by suite or test name",
   }),
-  watch: flags.boolean({
+  watch: Flags.boolean({
     string: "watch",
     description:
       "Watch files for changes and rerun tests related to changed files.",
   }),
-  watchAll: flags.boolean({
+  watchAll: Flags.boolean({
     string: "watchAll",
     description: "Watch files for changes and rerun all tests.",
   }),
-  database: flags.string({
+  database: Flags.string({
     string: "database",
     description: "Run on specified database. Default is saltcorn_test",
   }),

package/src/commands/run-trigger.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, Args, ux } = require("@oclif/core");
 const { maybe_as_tenant, init_some_tenants } = require("../common");
 
 /**
@@ -16,7 +15,7 @@ class RunTriggerCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags, args } = this.parse(RunTriggerCommand);
+    const { flags, args } = await this.parse(RunTriggerCommand);
     await init_some_tenants(flags.tenant);
 
     const { mockReqRes } = require("@saltcorn/data/tests/mocks");
@@ -37,16 +36,22 @@ class RunTriggerCommand extends Command {
  */
 RunTriggerCommand.description = `Run a trigger`;
 
-RunTriggerCommand.args = [
-  /* { name: "tenant", required: false, description: "tenant name" }, */
-  { name: "trigger", required: true, description: "trigger name" },
-];
+RunTriggerCommand.args = {
+  trigger: Args.string({
+    required: true,
+    description: "trigger name",
+  }),
+  // tenant: Args.string({
+  //   required: false,
+  //   description: "tenant",
+  // }),
+};
 
 /**
  * @type {object}
  */
 RunTriggerCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     name: "tenant",
     char: "t",
     description: "tenant",

package/src/commands/scheduler.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/scheduler
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 
 /**
  * ScheduleCommand Class
@@ -14,7 +14,7 @@ class ScheduleCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags } = this.parse(ScheduleCommand);
+    const { flags } = await this.parse(ScheduleCommand);
     if (flags.verbose) {
       const db = require("@saltcorn/data/db");
       db.set_sql_logging();
@@ -33,7 +33,7 @@ ScheduleCommand.description = `Run the Saltcorn scheduler`;
  * @type {object}
  */
 ScheduleCommand.flags = {
-  verbose: flags.boolean({ char: "v", description: "Verbose" }),
+  verbose: Flags.boolean({ char: "v", description: "Verbose" }),
 };
 
 module.exports = ScheduleCommand;

package/src/commands/serve.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/serve
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const si = require("systeminformation");
 
 /**
@@ -15,7 +15,7 @@ class ServeCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags } = this.parse(ServeCommand);
+    const { flags } = await this.parse(ServeCommand);
     const cpu = await si.cpu();
     const serveArgs = {
       defaultNCPUs: cpu.performanceCores || cpu.physicalCores,
@@ -61,18 +61,18 @@ ServeCommand.description = `Start the Saltcorn server`;
  * @type {object}
  */
 ServeCommand.flags = {
-  port: flags.integer({ char: "p", description: "port", default: 3000 }),
-  verbose: flags.boolean({ char: "v", description: "Verbose" }),
-  watchReaper: flags.boolean({ char: "r", description: "Watch reaper" }),
-  dev: flags.boolean({
+  port: Flags.integer({ char: "p", description: "port", default: 3000 }),
+  verbose: Flags.boolean({ char: "v", description: "Verbose" }),
+  watchReaper: Flags.boolean({ char: "r", description: "Watch reaper" }),
+  dev: Flags.boolean({
     string: "dev",
     char: "d",
     description: "Run in dev mode and re-start on file changes",
   }),
-  addschema: flags.boolean({ char: "a", description: "Add schema if missing" }),
-  nomigrate: flags.boolean({ char: "n", description: "No migrations" }),
-  noscheduler: flags.boolean({ char: "s", description: "No scheduler" }),
-  subdomain_offset: flags.integer({
+  addschema: Flags.boolean({ char: "a", description: "Add schema if missing" }),
+  nomigrate: Flags.boolean({ char: "n", description: "No migrations" }),
+  noscheduler: Flags.boolean({ char: "s", description: "No scheduler" }),
+  subdomain_offset: Flags.integer({
     string: "subdomain_offset",
     description:
       "Number of parts to remove to access subdomain in 'multi_tenant' mode",

package/src/commands/set-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,
@@ -20,7 +19,7 @@ class SetCfgCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { args, flags } = this.parse(SetCfgCommand);
+    const { args, flags } = await this.parse(SetCfgCommand);
     if (args.key && !!args.value + !!flags.stdin + !!flags.file !== 1) {
       console.error(
         "Must supply one value, as argument, stdin (with -i), or file (with -f)"
@@ -68,31 +67,33 @@ SetCfgCommand.description = `Set a configuration value. The supplied value (argu
 /**
  * @type {object[]}
  */
-SetCfgCommand.args = [
-  { name: "key", required: false, description: "Configuration key" },
-  {
-    name: "value",
+SetCfgCommand.args = {
+  key: Args.string({
+    required: false,
+    description: "Configuration key",
+  }),
+  value: Args.string({
     description: "Configuration value (JSON or string)",
-  },
-];
+  }),
+};
 
 /**
  * @type {object}
  */
 SetCfgCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
-  plugin: flags.string({
+  plugin: Flags.string({
     char: "p",
     description: "plugin",
   }),
-  file: flags.string({
+  file: Flags.string({
     char: "f",
     description: "file",
   }),
-  stdin: flags.boolean({
+  stdin: Flags.boolean({
     char: "i",
     description: "read value from stdin",
   }),