Replace cli with commander (#892)

lib/bin/cli.js

@@ -23,21 +23,20 @@ const withPassword = (f) => {
   prompt.get([{ name: 'password', hidden: true, replace: '*' }], (_, { password }) => f(password));
 };
 
-// command line nonsense (i'm not a huge fan of this library).
-const cli = require('cli');
-const cliArgs = {
-  email: [ 'u', 'For user create and set password commands, supplies the email.', 'email' ]
-};
-const cliCommands = [ 'user-create', 'user-promote', 'user-set-password' ];
-cli.parse(cliArgs, cliCommands);
-
-// map commands to tasks.
-cli.main((args, options) => {
-  if (cli.command === 'user-create')
-    withPassword((password) => run(createUser(options.email, password)));
-  else if (cli.command === 'user-promote')
-    run(promoteUser(options.email));
-  else if (cli.command === 'user-set-password')
-    withPassword((password) => run(setUserPassword(options.email, password)));
-});
+const { Command } = require('commander');
+const program = new Command('node lib/bin/cli.js');
+
+const email = () => program.opts().email;
+
+program.requiredOption('-u, --email <email-address>');
+
+program.command('user-create')
+  .action(() => withPassword((password) => run(createUser(email(), password))));
+
+program.command('user-promote')
+  .action(() => run(promoteUser(email())));
+
+program.command('user-set-password')
+  .action(() => withPassword((password) => run(setUserPassword(email(), password))));
 
+program.parse();

lib/bin/create-docker-databases.js

@@ -11,18 +11,19 @@
 // be run in a Docker environment in which the POSTGRES_PASSWORD environment
 // variable is set to 'odktest'.
 
-const cli = require('cli');
 const knex = require('knex');
+const { program } = require('commander');
 
 const connect = (database) => knex({
   client: 'pg',
   connection: { host: 'localhost', user: 'postgres', password: 'odktest', database }
 });
 
-cli.parse({
-  log: ['l', 'Print all db statements to log.', 'bool']
-});
-cli.main(async (_, { log }) => {
+program.option('-l', 'Print all db statements to log.');
+program.parse();
+const { log } = program.opts();
+
+(async () => {
   const dbmain = connect('postgres');
   await dbmain.raw("create user jubilant with password 'jubilant';");
   await Promise.all(['jubilant', 'jubilant_test'].map(async (database) => {
@@ -41,4 +42,4 @@ cli.main(async (_, { log }) => {
   }
 
   dbmain.destroy();
-});
+})();

lib/bin/purge-forms.js

@@ -13,14 +13,13 @@
 const { run } = require('../task/task');
 const { purgeForms } = require('../task/purge');
 
-const cli = require('cli');
-const cliArgs = {
-  force: [ 'f', 'Force any soft-deleted form to be purged right away.', 'bool', false ],
-  formId: [ 'i', 'Purge a specific form based on its id.', 'int' ],
-  projectId: [ 'p', 'Restrict purging to a specific project.', 'int' ],
-};
-cli.parse(cliArgs);
+const { program } = require('commander');
+program.option('-f', 'Force any soft-deleted form to be purged right away.');
+program.option('-i <integer>', 'Purge a specific form based on its id.', parseInt);
+program.option('-p <integer>', 'Restrict purging to a specific project.', parseInt);
+program.parse();
 
-cli.main((args, options) =>
-  run(purgeForms(options.force, options.formId, options.projectId)
-    .then((count) => `Forms purged: ${count}`)));
+const options = program.opts();
+
+run(purgeForms(options.force, options.formId, options.projectId)
+  .then((count) => `Forms purged: ${count}`));

lib/bin/run-analytics.js

@@ -14,12 +14,10 @@
 const { run } = require('../task/task');
 const { runAnalytics } = require('../task/analytics');
 
-const cli = require('cli');
-const cliArgs = {
-  force: [ 'f', 'Force analytics to be sent (if configured) even if not scheduled yet.', 'bool' ]
-};
-cli.parse(cliArgs);
+const { program } = require('commander');
+program.option('-f', 'Force analytics to be sent (if configured) even if not scheduled yet.');
+program.parse();
 
-cli.main((args, options) => {
-  run(runAnalytics(options.force));
-});
+const options = program.opts();
+
+run(runAnalytics(options.force));

package.json

@@ -13,8 +13,8 @@
     "archiver": "~5",
     "bcrypt": "~5",
     "body-parser": "~1.20",
-    "cli": "~1",
     "cloneable-readable": "~2",
+    "commander": "^10.0.1",
     "config": "~1.31",
     "csv-parse": "~4",
     "csv-stringify": "~5",