miscellaneous updates

Author: CI Fix

bin/lib/cli.mjs

@@ -1,41 +1,44 @@
-import { Command } from 'commander';
-import loadInit from './init.mjs';
-import loadStart from './start.mjs';
-import loadInvalidUsernames from './invalidUsernames.mjs';
-import loadMigrateLegacyResources from './migrateLegacyResources.mjs';
-import loadUpdateIndex from './updateIndex.mjs';
-import { spawnSync } from 'child_process';
-import path from 'path';
-import { fileURLToPath } from 'url';
+import { Command } from 'commander'
+import loadInit from './init.mjs'
+import loadStart from './start.mjs'
+import loadInvalidUsernames from './invalidUsernames.mjs'
+import loadMigrateLegacyResources from './migrateLegacyResources.mjs'
+import loadUpdateIndex from './updateIndex.mjs'
+import { spawnSync } from 'child_process'
+import path from 'path'
+import fs from 'fs'
+import { fileURLToPath } from 'url'
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
 
-export default function startCli(server) {
-  const program = new Command();
-  program.version(getVersion());
-  loadInit(program);
-  loadStart(program, server);
-  loadInvalidUsernames(program);
-  loadMigrateLegacyResources(program);
-  loadUpdateIndex(program);
-  program.parse(process.argv);
-  if (program.args.length === 0) program.help();
+export default function startCli (server) {
+  const program = new Command()
+  program.version(getVersion())
+
+  loadInit(program)
+  loadStart(program, server)
+  loadInvalidUsernames(program)
+  loadMigrateLegacyResources(program)
+  loadUpdateIndex(program)
+
+  program.parse(process.argv)
+  if (program.args.length === 0) program.help()
 }
 
-function getVersion() {
+function getVersion () {
   try {
-    const options = { cwd: __dirname, encoding: 'utf8' };
-    const { stdout } = spawnSync('git', ['describe', '--tags'], options);
-    const { stdout: gitStatusStdout } = spawnSync('git', ['status'], options);
-    const version = stdout.trim();
+    const options = { cwd: __dirname, encoding: 'utf8' }
+    const { stdout } = spawnSync('git', ['describe', '--tags'], options)
+    const { stdout: gitStatusStdout } = spawnSync('git', ['status'], options)
+    const version = stdout.trim()
     if (version === '' || gitStatusStdout.match('Not currently on any branch')) {
-      throw new Error('No git version here');
+      throw new Error('No git version here')
     }
-    return version;
+    return version
   } catch (e) {
-    const pkgPath = path.join(__dirname, '../../package.json');
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
-    return pkg.version;
+    const pkgPath = path.join(__dirname, '../../package.json')
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'))
+    return pkg.version
   }
 }

bin/lib/init.mjs

@@ -1,59 +1,67 @@
-import inquirer from 'inquirer';
-import fs from 'fs';
-import options from './options.mjs';
-import camelize from 'camelize';
+import inquirer from 'inquirer'
+import fs from 'fs'
+import options from './options.mjs'
+import camelize from 'camelize'
 
-let questions = options.map((option) => {
-  if (!option.type) {
-    if (option.flag) {
-      option.type = 'confirm';
-    } else {
-      option.type = 'input';
+let questions = options
+  .map((option) => {
+    if (!option.type) {
+      if (option.flag) {
+        option.type = 'confirm'
+      } else {
+        option.type = 'input'
+      }
     }
-  }
-  option.message = option.question || option.help;
-  return option;
-});
+
+    option.message = option.question || option.help
+    return option
+  })
 
 export default function (program) {
   program
     .command('init')
     .option('--advanced', 'Ask for all the settings')
     .description('create solid server configurations')
     .action((opts) => {
-      let filteredQuestions = questions;
+      // Filter out advanced commands
+      let filtered = questions
       if (!opts.advanced) {
-        filteredQuestions = filteredQuestions.filter((option) => option.prompt);
+        filtered = filtered.filter((option) => option.prompt)
       }
-      inquirer.prompt(filteredQuestions)
+
+      // Prompt to the user
+      inquirer.prompt(filtered)
         .then((answers) => {
-          manipulateEmailSection(answers);
-          manipulateServerSection(answers);
-          cleanupAnswers(answers);
-          const config = JSON.stringify(camelize(answers), null, '  ');
-          const configPath = process.cwd() + '/config.json';
+          manipulateEmailSection(answers)
+          manipulateServerSection(answers)
+          cleanupAnswers(answers)
+
+          // write config file
+          const config = JSON.stringify(camelize(answers), null, '  ')
+          const configPath = process.cwd() + '/config.json'
+
           fs.writeFile(configPath, config, (err) => {
             if (err) {
-              return console.log('failed to write config.json');
+              return console.log('failed to write config.json')
             }
-            console.log('config created on', configPath);
-          });
+            console.log('config created on', configPath)
+          })
         })
         .catch((err) => {
-          console.log('Error:', err);
-        });
-    });
+          console.log('Error:', err)
+        })
+    })
 }
 
-function cleanupAnswers(answers) {
+function cleanupAnswers (answers) {
   Object.keys(answers).forEach((answer) => {
     if (answer.startsWith('use')) {
-      delete answers[answer];
+      delete answers[answer]
     }
-  });
+  })
 }
 
-function manipulateEmailSection(answers) {
+function manipulateEmailSection (answers) {
   if (answers.useEmail) {
     answers.email = {
       host: answers['email-host'],
@@ -63,23 +71,24 @@ function manipulateEmailSection(answers) {
         user: answers['email-auth-user'],
         pass: answers['email-auth-pass']
       }
-    };
-    delete answers['email-host'];
-    delete answers['email-port'];
-    delete answers['email-auth-user'];
-    delete answers['email-auth-pass'];
+    }
+    delete answers['email-host']
+    delete answers['email-port']
+    delete answers['email-auth-user']
+    delete answers['email-auth-pass']
   }
 }
 
-function manipulateServerSection(answers) {
+function manipulateServerSection (answers) {
   answers.server = {
     name: answers['server-info-name'],
     description: answers['server-info-description'],
     logo: answers['server-info-logo']
-  };
+  }
   Object.keys(answers).forEach((answer) => {
     if (answer.startsWith('server-info-')) {
-      delete answers[answer];
+      delete answers[answer]
     }
-  });
+  })
 }
+

bin/lib/options.mjs

@@ -1,16 +1,11 @@
-import fs from 'fs';
-import path from 'path';
-import validUrl from 'valid-url';
-import { URL } from 'url';
-import validator from 'validator';
-const { isEmail } = validator;
+import fs from 'fs'
+import path from 'path'
+import validUrl from 'valid-url'
+import { URL } from 'url'
+import validator from 'validator'
+const { isEmail } = validator
 
 const options = [
-  // {
-  //   abbr: 'v',
-  //   flag: true,
-  //   help: 'Print the logs to console\n'
-  // },
   {
     name: 'root',
     help: "Root folder to serve (default: './data')",
@@ -80,9 +75,7 @@ const options = [
     filter: (value) => {
       if (value === 'WebID-OpenID Connect') return 'oidc'
     },
-    when: (answers) => {
-      return answers.webid
-    }
+    when: (answers) => answers.webid
   },
   {
     name: 'use-owner',
@@ -150,10 +143,6 @@ const options = [
     flag: true,
     default: false
   },
-  // {
-  //   full: 'default-app',
-  //   help: 'URI to use as a default app for resources (default: https://linkeddata.github.io/warp/#/list/)'
-  // },
   {
     name: 'use-cors-proxy',
     help: 'Do you want to have a CORS proxy endpoint?',
@@ -225,11 +214,6 @@ const options = [
       return value
     }
   },
-  // {
-  //   full: 'no-error-pages',
-  //   flag: true,
-  //   help: 'Disable custom error pages (use Node.js default pages instead)'
-  // },
   {
     name: 'error-pages',
     help: 'Folder from which to look for custom error pages files (files must be named <error-code>.html -- eg. 500.html)',
@@ -259,26 +243,20 @@ const options = [
     help: 'Host of your email service',
     prompt: true,
     default: 'smtp.gmail.com',
-    when: (answers) => {
-      return answers['use-email']
-    }
+    when: (answers) => answers['use-email']
   },
   {
     name: 'email-port',
     help: 'Port of your email service',
     prompt: true,
     default: '465',
-    when: (answers) => {
-      return answers['use-email']
-    }
+    when: (answers) => answers['use-email']
   },
   {
     name: 'email-auth-user',
     help: 'User of your email service',
     prompt: true,
-    when: (answers) => {
-      return answers['use-email']
-    },
+    when: (answers) => answers['use-email'],
     validate: (value) => {
       if (!value) {
         return 'You must enter this information'
@@ -291,9 +269,7 @@ const options = [
     help: 'Password of your email service',
     type: 'password',
     prompt: true,
-    when: (answers) => {
-      return answers['use-email']
-    }
+    when: (answers) => answers['use-email']
   },
   {
     name: 'use-api-apps',
@@ -307,42 +283,37 @@ const options = [
     help: 'Path to the folder to mount on /api/apps',
     prompt: true,
     validate: validPath,
-    when: (answers) => {
-      return answers['use-api-apps']
-    }
+    when: (answers) => answers['use-api-apps']
   },
-  { // copied from name: 'owner'
+  {
     name: 'redirect-http-from',
-    help: 'HTTP port or \',\'-separated ports to redirect to the solid server port (e.g. "80,8080").',
+    help: 'HTTP port or comma-separated ports to redirect to the solid server port (e.g. "80,8080").',
     prompt: false,
     validate: function (value) {
       if (!value.match(/^[0-9]+(,[0-9]+)*$/)) {
         return 'direct-port(s) must be a comma-separated list of integers.'
       }
       const list = value.split(/,/).map(v => parseInt(v))
       const bad = list.find(v => { return v < 1 || v > 65535 })
-      if (bad.length) {
+      if (bad && bad.length) {
         return 'redirect-http-from port(s) ' + bad + ' out of range'
       }
       return true
     }
   },
   {
-    // This property is packaged into an object for the server property in config.json
-    name: 'server-info-name', // All properties with prefix server-info- will be removed from the config
+    name: 'server-info-name',
     help: 'A name for your server (not required, but will be presented on your server\'s frontpage)',
     prompt: true,
     default: answers => new URL(answers['server-uri']).hostname
   },
   {
-    // This property is packaged into an object for the server property in config.json
-    name: 'server-info-description', // All properties with prefix server-info- will be removed from the config
+    name: 'server-info-description',
     help: 'A description of your server (not required)',
     prompt: true
   },
   {
-    // This property is packaged into an object for the server property in config.json
-    name: 'server-info-logo', // All properties with prefix server-info- will be removed from the config
+    name: 'server-info-logo',
     help: 'A logo that represents you, your brand, or your server (not required)',
     prompt: true
   },
@@ -381,28 +352,28 @@ const options = [
     },
     when: answers => answers.multiuser
   }
-];
+]
 
-function validPath(value) {
+function validPath (value) {
   if (value === 'default') {
-    return Promise.resolve(true);
+    return Promise.resolve(true)
   }
   if (!value) {
-    return Promise.resolve('You must enter a valid path');
+    return Promise.resolve('You must enter a valid path')
   }
   return new Promise((resolve) => {
     fs.stat(value, function (err) {
-      if (err) return resolve('Nothing found at this path');
-      return resolve(true);
-    });
-  });
+      if (err) return resolve('Nothing found at this path')
+      return resolve(true)
+    })
+  })
 }
 
-function validUri(value) {
+function validUri (value) {
   if (!validUrl.isUri(value)) {
-    return 'Enter a valid uri (with protocol)';
+    return 'Enter a valid uri (with protocol)'
   }
-  return true;
+  return true
 }
 
-export default options;
+export default options