@saltcorn/cli 0.6.0 → 0.6.1

package/src/commands/plugins.js

@@ -1,9 +1,18 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/plugins
+ */
 const { Command, flags } = require("@oclif/command");
 
 /**
  * Plugins list and update command
+ * @extends oclif.Command
+ * @category saltcorn-cli
  */
 class PluginsCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const db = require("@saltcorn/data/db");
     const { requirePlugin } = require("@saltcorn/server/load_plugins");
@@ -77,6 +86,9 @@ class PluginsCommand extends Command {
   }
 }
 
+/**
+ * @type {object}
+ */
 PluginsCommand.flags = {
   //list: flags.boolean({ char: "l", description: "List" }),
   upgrade: flags.boolean({ char: "u", description: "Upgrade" }),
@@ -91,17 +103,27 @@ PluginsCommand.flags = {
 };
 
 // TODO Extra documentation goes here
+/**
+ * @type {string}
+ */
 PluginsCommand.description = `List and upgrade plugins for tenants
 ...
 Extra documentation goes here
 `;
 
+/**
+ * @type {string}
+ */
 PluginsCommand.examples = [ //"plugins -l - outputs detailed information about plugins",
   "plugins -v - verbose output of commands",
   "plugins -u -d - dry-run for plugin update",
   "plugins -u -f - force plugin update"
 ];
+
 // TODO Extra help here
+/**
+ * @type {string}
+ */
 PluginsCommand.help= "Extra help here"
 
 // PluginsCommand.usage

package/src/commands/release.js

@@ -1,8 +1,20 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/release
+ */
 const { Command, flags } = require("@oclif/command");
 const fs = require("fs");
 const { spawnSync } = require("child_process");
 
+/**
+ * ReleaseCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class ReleaseCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const {
       args: { version },
@@ -10,6 +22,9 @@ class ReleaseCommand extends Command {
 
     const pkgs = {
       "@saltcorn/e2e": { dir: "e2e" },
+      "@saltcorn/db-common": { dir: "db-common", publish: true },
+      "@saltcorn/sqlite": { dir: "sqlite", publish: true },
+      "@saltcorn/postgres": { dir: "postgres", publish: true },
       "@saltcorn/builder": { dir: "saltcorn-builder", publish: true },
       "@saltcorn/data": { dir: "saltcorn-data", publish: true },
       "@saltcorn/random-tests": { dir: "saltcorn-random-tests" },
@@ -29,6 +44,8 @@ class ReleaseCommand extends Command {
             json.dependencies[dpkgnm] = version;
           if (json.devDependencies && json.devDependencies[dpkgnm])
             json.devDependencies[dpkgnm] = version;
+          if (json.optionalDependencies && json.optionalDependencies[dpkgnm])
+            json.optionalDependencies[dpkgnm] = version;
         });
       fs.writeFileSync(
         `packages/${dir}/package.json`,
@@ -71,7 +88,7 @@ class ReleaseCommand extends Command {
     publish("saltcorn-cli");
 
     // update Dockerfile
-    const dockerfile = fs.readFileSync(`Dockerfile.release`, 'utf8');
+    const dockerfile = fs.readFileSync(`Dockerfile.release`, "utf8");
     fs.writeFileSync(
       `Dockerfile.release`,
       dockerfile.replace(/cli\@.* --unsafe/, `cli@${version} --unsafe`)
@@ -95,8 +112,14 @@ class ReleaseCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 ReleaseCommand.description = `Release a new saltcorn version`;
 
+/**
+ * @type {object}
+ */
 ReleaseCommand.args = [
   { name: "version", required: true, description: "New version number" },
 ];

package/src/commands/reset-schema.js

@@ -1,8 +1,20 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/reset-schema
+ */
 const { Command, flags } = require("@oclif/command");
 const { cli } = require("cli-ux");
 const { maybe_as_tenant } = require("../common");
 
+/**
+ * ResetCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class ResetCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const reset = require("@saltcorn/data/db/reset_schema");
     const db = require("@saltcorn/data/db/");
@@ -24,11 +36,17 @@ class ResetCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 ResetCommand.description = `Reset the database
 ...
 This will delete all existing information
 `;
 
+/**
+ * @type {object}
+ */
 ResetCommand.flags = {
   force: flags.boolean({ char: "f", description: "force" }),
   tenant: flags.string({

package/src/commands/restore.js

@@ -1,9 +1,23 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/restore
+ */
 const { Command, flags } = require("@oclif/command");
 const { spawnSync } = require("child_process");
 const path = require("path");
 const { maybe_as_tenant } = require("../common");
 
+/**
+ * RestoreCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class RestoreCommand extends Command {
+  /**
+   * 
+   * @param {string} fnm 
+   * @returns {Promise<void>}
+   */
   async pg_restore(fnm) {
     const { getConnectObject } = require("@saltcorn/data/db/connect");
     const connobj = getConnectObject();
@@ -19,6 +33,13 @@ class RestoreCommand extends Command {
     );
     this.exit(res.status);
   }
+
+  /**
+   * 
+   * @param {string} fnm 
+   * @param {object} tenant 
+   * @returns {Promise<void>}
+   */
   async zip_restore(fnm, tenant) {
     const { restore } = require("@saltcorn/data/models/backup");
     const User = require("@saltcorn/data/models/user");
@@ -34,6 +55,10 @@ class RestoreCommand extends Command {
       }
     });
   }
+
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { args, flags } = this.parse(RestoreCommand);
     switch (path.extname(args.file)) {
@@ -54,12 +79,21 @@ class RestoreCommand extends Command {
   }
 }
 
+/**
+ * @type {object}
+ */
 RestoreCommand.args = [
   { name: "file", required: true, description: "backup file to restore" },
 ];
 
+/**
+ * @type {string}
+ */
 RestoreCommand.description = `Restore a previously backed up database (zip or sqlc format)`;
 
+/**
+ * @type {object}
+ */
 RestoreCommand.flags = {
   tenant: flags.string({
     char: "t",

package/src/commands/rm-tenant.js

@@ -1,6 +1,18 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/rm-tenant
+ */
 const { Command, flags } = require("@oclif/command");
 
+/**
+ * RmTenantCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class RmTenantCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { args } = this.parse(RmTenantCommand);
     const { deleteTenant } = require("@saltcorn/data/models/tenant");
@@ -9,12 +21,21 @@ class RmTenantCommand extends Command {
   }
 }
 
+/**
+ * @type {object}
+ */
 RmTenantCommand.args = [
   { name: "tenant", required: true, description: "Tenant to remove" },
 ];
 
+/**
+ * @type {string}
+ */
 RmTenantCommand.description = `Remove a tenant`;
 
+/**
+ * @type {object}
+ */
 RmTenantCommand.flags = {};
 
 module.exports = RmTenantCommand;

package/src/commands/run-benchmark.js

@@ -1,3 +1,7 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/run-nenchmark
+ */
 const { Command, flags } = require("@oclif/command");
 const si = require("systeminformation");
 const fetch = require("node-fetch");
@@ -6,9 +10,19 @@ const wrkCB = require("wrk");
 const { sleep } = require("../common");
 const packagejson = require("../../package.json");
 
+/**
+ * 
+ * @param {string} s 
+ * @returns {number}
+ */
 const parseMillisecs = (s) =>
   s.endsWith("ms") ? parseFloat(s) : parseFloat(s) * 1000;
 
+/**
+ * 
+ * @param {*} args 
+ * @returns {Promise<object>}
+ */
 const wrk = (args) =>
   new Promise(function (resolve, reject) {
     wrkCB(args, function (err, out) {
@@ -22,9 +36,22 @@ const wrk = (args) =>
     });
   });
 
+/**
+ * 
+ * @param {string} s 
+ * @returns {string}
+ */
 const ensure_no_final_slash = (s) => (s.endsWith("/") ? s.slice(0, -1) : s);
 
+/**
+ * RunBenchmarkCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class RunBenchmarkCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const {
       args: { baseurl },
@@ -108,12 +135,21 @@ class RunBenchmarkCommand extends Command {
   }
 }
 
+/**
+ * @type {object}
+ */
 RunBenchmarkCommand.args = [
   { name: "baseurl", required: false, description: "Base URL" },
 ];
 
+/**
+ * @type {string}
+ */
 RunBenchmarkCommand.description = `Run benchmark`;
 
+/**
+ * @type {object}
+ */
 RunBenchmarkCommand.flags = {
   token: flags.string({
     char: "t",

package/src/commands/run-tests.js

@@ -1,20 +1,42 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/run-tests
+ */
 const { Command, flags } = require("@oclif/command");
 
 const { spawnSync, spawn } = require("child_process");
 const { sleep } = require("../common");
 
+/**
+ * RunTestsCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class RunTestsCommand extends Command {
-  async do_test(cmd, args, env, forever, cwd, keepalive) {
+  /**
+   * 
+   * @param {string} cmd 
+   * @param {string[]} args 
+   * @param {*} env 
+   * @param {*} cwd 
+   * @param {boolean} keepalive 
+   * @returns {object}
+   */
+  async do_test(cmd, args, env, cwd, keepalive) {
     const res = spawnSync(cmd, args, {
       stdio: "inherit",
       env,
       cwd,
     });
-    if (forever && res.status === 0)
-      await this.do_test(cmd, args, env, forever, cwd);
-    else if (res.status !== 0 && !keepalive) this.exit(res.status);
+    if (res.status !== 0 && !keepalive) this.exit(res.status);
     return res;
   }
+
+  /**
+   * 
+   * @param {*} env 
+   * @returns {Promise<void>}
+   */
   async e2etest(env) {
     spawnSync("packages/saltcorn-cli/bin/saltcorn", ["fixtures", "-r"], {
       stdio: "inherit",
@@ -34,15 +56,39 @@ class RunTestsCommand extends Command {
       "npm",
       ["run", "gotest"],
       env,
-      false,
       "packages/e2e",
       true
     );
     server.kill();
     if (res.status !== 0) this.exit(res.status);
   }
+
+  /**
+   * 
+   * @param {object} args 
+   * @param {object} flags
+   * @throws {Error}
+   * @returns {void}
+   */
+  validateCall(args, flags) {
+    if (!args.package && flags.testFilter) {
+      throw new Error(
+        "No package name given. To use -t please specify a package or use core."
+      );
+    }
+    if (flags.watch && flags.watchAll) {
+      throw new Error(
+        "Ether use 'watch' or 'watchAll' but not both at the same time."
+      );
+    }
+  }
+  
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { args, flags } = this.parse(RunTestsCommand);
+    this.validateCall(args, flags);
     var env;
     const db = require("@saltcorn/data/db");
 
@@ -59,13 +105,24 @@ class RunTestsCommand extends Command {
     await reset();
     await fixtures();
     await db.close();
-    const covargs = flags.coverage ? ["--", "--coverage"] : [];
+    let jestParams = ["--"];
+    if (flags.coverage) {
+      jestParams.push("--coverage");
+    }
+    if (flags.testFilter) {
+      jestParams.push("-t", flags.testFilter);
+    }
+    if (flags.watch) {
+      jestParams.push("--watch");
+    }
+    if (flags.watchAll) {
+      jestParams.push("--watchAll");
+    }
     if (args.package === "core") {
       await this.do_test(
         "npm",
-        ["run", "test", ...covargs],
+        ["run", "test", ...jestParams],
         env,
-        flags.forever
       );
     } else if (args.package === "e2e") {
       await this.e2etest(env);
@@ -73,18 +130,16 @@ class RunTestsCommand extends Command {
       const cwd = "packages/" + args.package;
       await this.do_test(
         "npm",
-        ["run", "test", ...covargs],
+        ["run", "test", ...jestParams],
         env,
-        flags.forever,
-        cwd
+        cwd,
       );
     } else {
       const lerna = process.platform === "win32" ? "lerna.cmd" : "lerna";
       await this.do_test(
         lerna,
-        ["run", "test", ...covargs],
+        ["run", "test", ...jestParams],
         env,
-        flags.forever
       );
       await this.e2etest(env);
     }
@@ -92,18 +147,35 @@ class RunTestsCommand extends Command {
   }
 }
 
+/**
+ * @type {object}
+ */
 RunTestsCommand.args = [
   { name: "package", description: "which package to run tests for" },
 ];
 
+/**
+ * @type {string}
+ */
 RunTestsCommand.description = `Run test suites`;
 
+/**
+ * @type {object}
+ */
 RunTestsCommand.flags = {
   coverage: flags.boolean({ char: "c", description: "Coverage" }),
-  forever: flags.boolean({
-    char: "f",
-    description: "Run forever till failure",
+  testFilter: flags.string({
+    char: "t",
+    description: "Filter tests by suite or test name",
+  }),
+  watch: flags.boolean({
+    string: "watch",
+    description: "Watch files for changes and rerun tests related to changed files."
   }),
+  watchAll: flags.boolean({
+    string: "watchAll",
+    description: "Watch files for changes and rerun all tests."
+  })
 };
 
 module.exports = RunTestsCommand;

package/src/commands/scheduler.js

@@ -1,5 +1,18 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/scheduler
+ */
 const { Command, flags } = require("@oclif/command");
+
+/**
+ * ScheduleCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class ScheduleCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { flags } = this.parse(ScheduleCommand);
     if (flags.verbose) {
@@ -11,8 +24,14 @@ class ScheduleCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 ScheduleCommand.description = `Run the Saltcorn scheduler`;
 
+/**
+ * @type {object}
+ */
 ScheduleCommand.flags = {
   verbose: flags.boolean({ char: "v", description: "Verbose" }),
 };

package/src/commands/serve.js

@@ -1,7 +1,19 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/serve
+ */
 const { Command, flags } = require("@oclif/command");
 const si = require("systeminformation");
 
+/**
+ * ServeCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class ServeCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { flags } = this.parse(ServeCommand);
     const cpu = await si.cpu();
@@ -37,8 +49,14 @@ class ServeCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 ServeCommand.description = `Start the Saltcorn server`;
 
+/**
+ * @type {object}
+ */
 ServeCommand.flags = {
   port: flags.integer({ char: "p", description: "port", default: 3000 }),
   port: flags.integer({ char: "p", description: "port", default: 3000 }),

package/src/commands/set-cfg.js

@@ -1,8 +1,20 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/set-cfg
+ */
 const { Command, flags } = require("@oclif/command");
 const { cli } = require("cli-ux");
 const { maybe_as_tenant, parseJSONorString } = require("../common");
 
+/**
+ * SetCfgCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class SetCfgCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { args, flags } = this.parse(SetCfgCommand);
     await maybe_as_tenant(flags.tenant, async () => {
@@ -20,7 +32,14 @@ class SetCfgCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 SetCfgCommand.description = `Set a configuration value`;
+
+/**
+ * @type {object[]}
+ */
 SetCfgCommand.args = [
   { name: "key", required: true, description: "Configuration key" },
   {
@@ -29,6 +48,10 @@ SetCfgCommand.args = [
     description: "Configuration value (JSON or string)",
   },
 ];
+
+/**
+ * @type {object}
+ */
 SetCfgCommand.flags = {
   tenant: flags.string({
     char: "t",

package/src/commands/setup-benchmark.js

@@ -1,7 +1,19 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/setup-benchmark
+ */
 const { Command, flags } = require("@oclif/command");
 const { maybe_as_tenant } = require("../common");
 
+/**
+ * SetupBenchmarkCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class SetupBenchmarkCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async install_forum_pack() {
     const {
       fetch_pack_by_name,
@@ -17,6 +29,10 @@ class SetupBenchmarkCommand extends Command {
       load_plugins.loadAndSaveNewPlugin(p)
     );
   }
+  
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { args, flags } = this.parse(SetupBenchmarkCommand);
     await maybe_as_tenant(flags.tenant, async () => {
@@ -62,10 +78,17 @@ class SetupBenchmarkCommand extends Command {
   }
 }
 
+/** @type {object[]} */
 SetupBenchmarkCommand.args = [];
 
+/**
+ * @type {string}
+ */
 SetupBenchmarkCommand.description = `Setup an instance for benchmarking`;
 
+/**
+ * @type {object}
+ */
 SetupBenchmarkCommand.flags = {
   tenant: flags.string({
     char: "t",