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

package/package.json

@@ -2,25 +2,22 @@
   "name": "@saltcorn/cli",
   "description": "Command-line interface for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.5",
   "author": "Tom Nielsen @glutamate",
   "bin": {
     "saltcorn": "./bin/saltcorn"
   },
   "bugs": "https://github.com/saltcorn/saltcorn/issues",
   "dependencies": {
-    "@oclif/command": "^1.8.16",
-    "@oclif/config": "^1.18.3",
-    "@oclif/plugin-plugins": "^2.1.0",
-    "@oclif/plugin-help": "^3.3.1",
-    "@saltcorn/admin-models": "1.0.0-beta.1",
-    "@saltcorn/common-code": "1.0.0-beta.1",
-    "@saltcorn/data": "1.0.0-beta.1",
-    "@saltcorn/mobile-app": "1.0.0-beta.1",
-    "@saltcorn/mobile-builder": "1.0.0-beta.1",
-    "@saltcorn/plugins-loader": "1.0.0-beta.1",
-    "@saltcorn/server": "1.0.0-beta.1",
-    "cli-ux": "^5.6.7",
+    "@oclif/core": "^2.16.0",
+    "@oclif/plugin-plugins": "^3.9.4",
+    "@saltcorn/admin-models": "1.0.0-beta.5",
+    "@saltcorn/common-code": "1.0.0-beta.5",
+    "@saltcorn/data": "1.0.0-beta.5",
+    "@saltcorn/mobile-app": "1.0.0-beta.5",
+    "@saltcorn/mobile-builder": "1.0.0-beta.5",
+    "@saltcorn/plugins-loader": "1.0.0-beta.5",
+    "@saltcorn/server": "1.0.0-beta.5",
     "contractis": "^0.1.0",
     "dateformat": "^3.0.3",
     "inquirer": "^7.3.3",
@@ -34,7 +31,7 @@
     "wrk": "^1.2.1"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.26.10",
+    "oclif": "3.17.2",
     "globby": "^10.0.2",
     "ts-node": "^9.1.1"
   },
@@ -55,22 +52,14 @@
   "oclif": {
     "commands": "./src/commands",
     "bin": "saltcorn",
-    "plugins": [
-      "@oclif/plugin-help"
-    ],
-    "repositoryPrefix": "<%- repo %>/blob/v<%- version %>/packages/saltcorn-cli/<%- commandPath %>",
-    "topics": {
-      "dev": {
-        "description": "Tools for core and plugin developers"
-      }
-    }
+    "repositoryPrefix": "<%- repo %>/blob/v<%- version %>/packages/saltcorn-cli/<%- commandPath %>"
   },
   "repository": "github:saltcorn/saltcorn",
   "scripts": {
     "postpack": "rm -f oclif.manifest.json",
-    "prepack": "oclif-dev manifest && oclif-dev readme",
+    "prepack": "oclif manifest && oclif readme",
     "test": "echo NO TESTS",
-    "version": "oclif-dev readme && git add README.md",
+    "version": "oclif readme && git add README.md",
     "tsc": "echo \"Error: no TypeScript support yet\"",
     "clean": "echo \"Error: no TypeScript support yet\""
   },

package/src/commands/add-schema.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/add-schema
  */
-const { Command, flags } = require("@oclif/command");
-const { cli } = require("cli-ux");
+const { Command, Flags, ux } = require("@oclif/core");
 
 /**
  * AddSchemaCommand Class
@@ -15,12 +14,12 @@ class AddSchemaCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-
-    const { flags } = this.parse(AddSchemaCommand);
+    const { flags } = await this.parse(AddSchemaCommand);
     const reset = require("@saltcorn/data/db/reset_schema");
-    if(!flags.force){
-      const ans = await cli.confirm(
-        `This add Saltcorn schema to existing database\nContinue (y/n)?`);
+    if (!flags.force) {
+      const ans = await ux.confirm(
+        `This adds Saltcorn schema to existing database\nContinue (y/n)?`
+      );
       if (!ans) {
         console.log(`Success: Command execution canceled`);
         this.exit(1);
@@ -46,7 +45,7 @@ AddSchemaCommand.help = `Add Saltcorn schema to existing database`;
  * @type {object}
  */
 AddSchemaCommand.flags = {
-  force: flags.boolean({ char: "f", description: "force command execution" }),
+  force: Flags.boolean({ char: "f", description: "force command execution" }),
 };
 
 module.exports = AddSchemaCommand;

package/src/commands/backup.js

@@ -3,7 +3,7 @@
  * @category saltcorn-cli
  * @module commands/backup
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const { execSync } = require("child_process");
 const dateFormat = require("dateformat");
 const os = require("os");
@@ -26,7 +26,7 @@ class BackupCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags } = this.parse(BackupCommand);
+    const { flags } = await this.parse(BackupCommand);
 
     if (flags.tenant) {
       // for tenant do saltcorn backup
@@ -106,16 +106,16 @@ BackupCommand.help = `Backup the PostgreSQL database to a file with pg_dump or s
  * @type {object}
  */
 BackupCommand.flags = {
-  verbose: flags.boolean({ char: "v", description: "Verbose" }),
-  output: flags.string({
+  verbose: Flags.boolean({ char: "v", description: "Verbose" }),
+  output: Flags.string({
     char: "o",
     description: "output filename",
   }),
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "Backup tenant in saltcorn zip format",
   }),
-  zip: flags.boolean({
+  zip: Flags.boolean({
     char: "z",
     description: "Backup public in saltcorn zip format",
   }),

package/src/commands/build-app.js

@@ -1,4 +1,4 @@
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const path = require("path");
 const Plugin = require("@saltcorn/data/models/plugin");
 const { MobileBuilder } = require("@saltcorn/mobile-builder/mobile-builder");
@@ -61,7 +61,7 @@ class BuildAppCommand extends Command {
   }
 
   async run() {
-    const { flags } = await this.parse(BuildAppCommand);
+    const { flags } = await await this.parse(BuildAppCommand);
     this.validateParameters(flags);
     const mobileAppDir = path.join(
       require.resolve("@saltcorn/mobile-app"),
@@ -122,43 +122,43 @@ class BuildAppCommand extends Command {
 BuildAppCommand.description = "Build mobile app";
 
 BuildAppCommand.flags = {
-  tenantAppName: flags.string({
+  tenantAppName: Flags.string({
     name: "tenant",
     string: "tenant",
     description:
       "Optional name of a tenant application, if set, the app will be build for this tenant",
   }),
-  platforms: flags.string({
+  platforms: Flags.string({
     name: "platforms",
     char: "p",
     description: "Platforms to build for, space separated list",
     multiple: true,
   }),
-  entryPoint: flags.string({
+  entryPoint: Flags.string({
     name: "entry point",
     char: "e",
     description: "This is the first view or page (see -t) after the login.",
   }),
-  entryPointType: flags.string({
+  entryPointType: Flags.string({
     name: "entry point type",
     char: "t",
     description:
       "Type of the entry point ('view' or 'page'). The default is 'view'.",
   }),
-  localUserTables: flags.string({
+  localUserTables: Flags.string({
     name: "local user tables",
     char: "l",
     description: "user defined tables that should be replicated into the app",
     multiple: true,
   }),
-  synchedTables: flags.string({
+  synchedTables: Flags.string({
     name: "synched tables",
     string: "synchedTables",
     description:
       "Table names for which the offline should be synchronized with the saltcorn server",
     multiple: true,
   }),
-  includedPlugins: flags.string({
+  includedPlugins: Flags.string({
     name: "included plugins",
     string: "includedPlugins",
     description:
@@ -166,92 +166,92 @@ BuildAppCommand.flags = {
       "If empty, no modules are used.",
     multiple: true,
   }),
-  useDocker: flags.boolean({
+  useDocker: Flags.boolean({
     name: "use docker build container",
     char: "d",
     description: "Use a docker container to build the app.",
   }),
-  buildDirectory: flags.string({
+  buildDirectory: Flags.string({
     name: "build directory",
     char: "b",
     description: "A directory where the app should be build",
   }),
-  copyAppDirectory: flags.string({
+  copyAppDirectory: Flags.string({
     name: "app target-directory",
     char: "c",
     description:
       "If set, the app file will be copied here, please set 'user email', too",
   }),
-  userEmail: flags.string({
+  userEmail: Flags.string({
     name: "user email",
     char: "u",
     description: "Email of the user building the app",
   }),
-  appName: flags.string({
+  appName: Flags.string({
     name: "app name",
     string: "appName",
     description: "Name of the mobile app (default SaltcornMobileApp)",
   }),
-  appId: flags.string({
+  appId: Flags.string({
     name: "app id",
     string: "appId",
     description: "Id of the mobile app (default com.saltcorn.mobileapp)",
   }),
-  appVersion: flags.string({
+  appVersion: Flags.string({
     name: "app version",
     string: "appVersion",
     description: "Version of the mobile app (default 1.0.0)",
   }),
-  appIcon: flags.string({
+  appIcon: Flags.string({
     name: "app icon",
     string: "appIcon",
     description:
       "A png that will be used as launcher icon. The default is a png of a saltcorn symbol.",
   }),
-  serverURL: flags.string({
+  serverURL: Flags.string({
     name: "server URL",
     char: "s",
     description: "URL to a saltcorn server",
   }),
-  splashPage: flags.string({
+  splashPage: Flags.string({
     name: "splash page",
     string: "splashPage",
     description:
       "Name of a page that should be shown while the app is loading.",
   }),
-  autoPublicLogin: flags.boolean({
+  autoPublicLogin: Flags.boolean({
     name: "auto public login",
     string: "autoPublicLogin",
     description: "Show public entry points before the login as a public user.",
   }),
-  allowOfflineMode: flags.boolean({
+  allowOfflineMode: Flags.boolean({
     name: "Allow offline mode",
     string: "allowOfflineMode",
     description:
       "Switch to offline mode when there is no internet, sync the data when a connection is available again.",
   }),
-  provisioningProfile: flags.string({
+  provisioningProfile: Flags.string({
     name: "provisioning profile",
     string: "provisioningProfile",
     description: "This profile will be used to sign your app",
   }),
-  buildType: flags.string({
+  buildType: Flags.string({
     name: "build type",
     string: "buildType",
     description: "debug or release build",
   }),
-  androidKeystore: flags.string({
+  androidKeystore: Flags.string({
     name: "android key store",
     string: "androidKeyStore",
     description:
       "A self-signed certificate that includes the private key used to sign your app.",
   }),
-  androidKeyStoreAlias: flags.string({
+  androidKeyStoreAlias: Flags.string({
     name: "android key store alias",
     string: "keyStoreAlias",
     description: "A unique name to identify the key within the keystore file.",
   }),
-  androidKeystorePassword: flags.string({
+  androidKeystorePassword: Flags.string({
     name: "android key store password",
     string: "keyStorePassword",
     description: "he password to access the keystore file.",

package/src/commands/build-cordova-builder.js

@@ -1,4 +1,4 @@
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 const { join } = require("path");
 const { spawnSync } = require("child_process");
 
@@ -9,7 +9,7 @@ const { spawnSync } = require("child_process");
  */
 class BuildCordovaBuilder extends Command {
   async run() {
-    const { flags } = this.parse(BuildCordovaBuilder);
+    const { flags } = await this.parse(BuildCordovaBuilder);
     const dockerDir = join(
       require.resolve("@saltcorn/mobile-builder"),
       "..",
@@ -38,7 +38,7 @@ BuildCordovaBuilder.help =
   "Please make sure docker is callable without using root (see rootless mode, or add the user to the docker group).";
 
 BuildCordovaBuilder.flags = {
-  buildClean: flags.boolean({
+  buildClean: Flags.boolean({
     name: "build clean",
     string: "clean",
     description: "run a clean build with --no-cache",

package/src/commands/configuration-check-backups.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/configuration-check-backups
  */
-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");
 
 /**
@@ -17,7 +16,7 @@ class ConfigurationCheckBackupsCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { argv, flags } = this.parse(ConfigurationCheckBackupsCommand);
+    const { argv, flags } = await this.parse(ConfigurationCheckBackupsCommand);
     //await init_some_tenants(flags.tenant);
     const {
       runConfigurationCheck,
@@ -95,16 +94,15 @@ ConfigurationCheckBackupsCommand.description = `Check configuration`;
 /**
  * @type {object}
  */
-ConfigurationCheckBackupsCommand.args = [
-  {
-    name: "files",
+ConfigurationCheckBackupsCommand.args = {
+  files: Args.string({
     required: true,
     description: "backup file to check. can be repeated, e.g. with *",
-  },
-];
+  }),
+};
 
 ConfigurationCheckBackupsCommand.flags = {
-  destructive: flags.boolean({
+  destructive: Flags.boolean({
     char: "d",
     description: "destructive",
   }),

package/src/commands/configuration-check.js

@@ -2,8 +2,7 @@
  * @category saltcorn-cli
  * @module commands/configuration-check
  */
-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,7 +15,7 @@ class ConfigurationCheckCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { flags } = this.parse(ConfigurationCheckCommand);
+    const { flags } = await this.parse(ConfigurationCheckCommand);
     await init_some_tenants(flags.tenant);
     const {
       runConfigurationCheck,
@@ -56,11 +55,11 @@ ConfigurationCheckCommand.description = `Check configuration`;
  * @type {object}
  */
 ConfigurationCheckCommand.flags = {
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
-  /*destructive: flags.boolean({
+  /*destructive: Flags.boolean({
     char: "d",
     description: "destructive",
   }),*/

package/src/commands/create-tenant.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/create-tenant
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 
 //const {
 //  getConfig,
@@ -18,8 +18,7 @@ class CreateTenantCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { args } = this.parse(CreateTenantCommand);
-    const { flags } = this.parse(CreateTenantCommand);
+    const { args, flags } = await this.parse(CreateTenantCommand);
     const db = require("@saltcorn/data/db");
     const { add_tenant } = require("@saltcorn/data/db/state");
     if (!db.is_it_multi_tenant()) {
@@ -51,9 +50,12 @@ class CreateTenantCommand extends Command {
 /**
  * @type {object}
  */
-CreateTenantCommand.args = [
-  { name: "tenant", required: true, description: "Tenant subdomain to create" },
-];
+CreateTenantCommand.args = {
+  tenant: Args.string({
+    required: true,
+    description: "Tenant subdomain to create",
+  }),
+};
 
 /**
  * @type {string}
@@ -64,17 +66,17 @@ CreateTenantCommand.description = `Create a tenant`;
  * @type {object}
  */
 CreateTenantCommand.flags = {
-  url: flags.string({
+  url: Flags.string({
     name: "url",
     //char: "",
     description: "Url of tenant",
   }),
-  email: flags.string({
+  email: Flags.string({
     name: "email",
     char: "e",
     description: "Email of owner of tenant",
   }),
-  description: flags.string({
+  description: Flags.string({
     name: "description",
     char: "d",
     description: "Description of tenant",

package/src/commands/create-user.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, 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 CreateUserCommand extends Command {
   async run() {
     const User = require("@saltcorn/data/models/user");
 
-    const { flags } = this.parse(CreateUserCommand);
+    const { flags } = await this.parse(CreateUserCommand);
     if (flags.admin && flags.role && flags.role !== "admin") {
       console.error("Error: specify at most one of admin and role");
       this.exit(1);
@@ -39,9 +38,9 @@ class CreateUserCommand extends Command {
         }
         role_id = role.id;
       }
-      const email = flags.email || (await cli.prompt("Email address"));
+      const email = flags.email || (await ux.prompt("Email address"));
       const password =
-        flags.password || (await cli.prompt("Password", { type: "hide" }));
+        flags.password || (await ux.prompt("Password", { type: "hide" }));
       const u = await User.create({ email, password, role_id });
       if (u instanceof User)
         console.log(
@@ -66,20 +65,20 @@ CreateUserCommand.description = `Create a new user`;
  * @type {object}
  */
 CreateUserCommand.flags = {
-  admin: flags.boolean({ char: "a", description: "Admin user" }),
-  tenant: flags.string({
+  admin: Flags.boolean({ char: "a", description: "Admin user" }),
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),
-  email: flags.string({
+  email: Flags.string({
     char: "e",
     description: "email",
   }),
-  role: flags.string({
+  role: Flags.string({
     char: "r",
     description: "role",
   }),
-  password: flags.string({
+  password: Flags.string({
     char: "p",
     description: "password",
   }),

package/src/commands/delete-tenants.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/delete-tenants
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 
 /**
  * DeleteTenantsCommand Class

package/src/commands/delete-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 } = require("../common");
 
 /**
@@ -20,8 +19,8 @@ class DeleteUserCommand extends Command {
   async run() {
     const User = require("@saltcorn/data/models/user");
 
-    const { args } = this.parse(DeleteUserCommand);
-    const { flags } = this.parse(DeleteUserCommand);
+    const { args } = await this.parse(DeleteUserCommand);
+    const { flags } = await this.parse(DeleteUserCommand);
 
     // run function as specified tenant
     await maybe_as_tenant(flags.tenant, async () => {
@@ -39,7 +38,7 @@ class DeleteUserCommand extends Command {
       // make changes
       // todo handle errors
       if (!flags.force) {
-        const ans = await cli.confirm(
+        const ans = await ux.confirm(
           `This will delete user ${args.user_email} ${
             typeof flags.tenant !== "undefined" ? "from " + flags.tenant : ""
           }.\nContinue (y/n)?`
@@ -65,9 +64,12 @@ class DeleteUserCommand extends Command {
 /**
  * @type {object}
  */
-DeleteUserCommand.args = [
-  { name: "user_email", required: true, description: "User to delete" },
-];
+DeleteUserCommand.args = {
+  user_email: Args.string({
+    required: true,
+    description: "User to delete",
+  }),
+};
 
 /**
  * @type {string}
@@ -91,8 +93,8 @@ Command deletes the user specified by USER_EMAIL.
  * @type {object}
  */
 DeleteUserCommand.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/dev/localize-plugin.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/localize-plugin
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags, Args } = require("@oclif/core");
 const { maybe_as_tenant } = require("../../common");
 const path = require("path");
 
@@ -18,7 +18,7 @@ class LocalizePluginCommand extends Command {
   async run() {
     const db = require("@saltcorn/data/db");
     const Plugin = require("@saltcorn/data/models/plugin");
-    const { args, flags } = this.parse(LocalizePluginCommand);
+    const { args, flags } = await this.parse(LocalizePluginCommand);
     await maybe_as_tenant(flags.tenant, async () => {
       const plugin = await Plugin.findOne({ name: args.plugin });
       if (
@@ -50,13 +50,15 @@ class LocalizePluginCommand extends Command {
   }
 }
 
-LocalizePluginCommand.args = [
-  { name: "plugin", required: true, description: "Current plugin name" },
-  {
-    name: "path",
+LocalizePluginCommand.args = {
+  plugin: Args.string({
+    required: true,
+    description: "Current plugin name",
+  }),
+  path: Args.string({
     description: "Absolute path to local plugin",
-  },
-];
+  }),
+};
 
 /**
  * @type {string}
@@ -67,11 +69,11 @@ LocalizePluginCommand.description = `Convert plugin to local plugin`;
  * @type {object}
  */
 LocalizePluginCommand.flags = {
-  unlocalize: flags.boolean({
+  unlocalize: Flags.boolean({
     char: "u",
     description: "Unlocalize plugin (local to npm)",
   }),
-  tenant: flags.string({
+  tenant: Flags.string({
     char: "t",
     description: "tenant",
   }),

package/src/commands/dev/make-migration.js

@@ -2,7 +2,7 @@
  * @category saltcorn-cli
  * @module commands/make-migration
  */
-const { Command, flags } = require("@oclif/command");
+const { Command, Flags } = require("@oclif/core");
 
 /**
  * MigrationCommand Class