feat(env): better developer support through env variables

fixes #14

Author: tripodsan

package-lock.json

@@ -33,14 +33,15 @@
   },
   "dependencies": {
     "@adobe/fastly-native-promises": "^1.3.2",
-    "@adobe/helix-shared": "0.10.0",
     "@adobe/helix-pipeline": "1.2.2",
+    "@adobe/helix-shared": "0.10.0",
     "@adobe/helix-simulator": "2.11.0",
     "@adobe/parcel-plugin-htl": "2.1.0",
     "@parcel/logger": "1.11.0",
     "@snyk/nodejs-runtime-agent": "1.42.1",
     "ajv": "^6.10.0",
     "archiver": "3.0.0",
+    "camelcase": "^5.3.1",
     "chalk": "2.4.2",
     "chokidar": "^2.1.5",
     "decompress": "4.2.0",

package.json

@@ -26,12 +26,14 @@ module.exports = function auth() {
     desc: 'Authenticate against 3rd party systems for development and deployment',
     builder: (yargs) => {
       yargs
+        .env('NO_HLX_ENV_SUPPORT_FOR_NOW')
         .option('github', {
           boolean: true,
           default: true,
           describe: 'Run authentication wizard for GitHub.',
         })
         .group(['github'/* , 'fastly', 'wsk' */], 'Services')
+        .strict()
         .help();
     },
     handler: async (argv) => {

src/auth.js

@@ -14,7 +14,7 @@
 
 /* eslint global-require: off */
 
-const { defaultArgs } = require('./defaults.js');
+const yargsBuild = require('./yargs-build.js');
 const { makeLogger } = require('./log-common.js');
 
 module.exports = function build() {
@@ -26,7 +26,7 @@ module.exports = function build() {
     command: 'build [files..]',
     desc: 'Compile the template functions and build package',
     builder: (yargs) => {
-      defaultArgs(yargs);
+      yargsBuild(yargs);
       yargs.help();
     },
     handler: async (argv) => {

src/build.js

@@ -29,8 +29,7 @@ module.exports = function demo() {
           alias: 'o',
           default: '.hlx/build',
           describe: 'Target directory for compiled JS',
-        })
-        .strict();
+        });
     },
     handler: async (argv) => {
       if (!executor) {

src/clean.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const yargs = require('yargs');
+const camelcase = require('camelcase');
 
 const MIN_MSG = 'You need at least one command.';
 
@@ -26,6 +27,37 @@ if (process.env.NODE_OPTIONS) {
     .join(' ');
 }
 
+function envAwareStrict(args, aliases) {
+  const specialKeys = ['$0', '--', '_'];
+  const illegalEnv = ['saveConfig', 'add', 'default'];
+
+  const hlxEnv = {};
+  Object
+    .keys(process.env)
+    .filter(key => key.startsWith('HLX_'))
+    .forEach((key) => {
+      hlxEnv[camelcase(key.substring(4))] = key;
+    });
+
+  illegalEnv.forEach((key) => {
+    if (key in hlxEnv) {
+      throw new Error(`${hlxEnv[key]} is not allowed in environment.`);
+    }
+  });
+
+  const unknown = [];
+  Object.keys(args).forEach((key) => {
+    if (specialKeys.indexOf(key) === -1 && !(key in hlxEnv) && !(key in aliases)) {
+      unknown.push(key);
+    }
+  });
+
+  if (unknown.length > 0) {
+    return unknown.length === 1 ? `Unknown argument: ${unknown[0]}` : `Unknown arguments: ${unknown.join(', ')}`;
+  }
+  return true;
+}
+
 /**
  * Adds the default logging options.
  * @param argv Yargs
@@ -61,10 +93,10 @@ class CLI {
       auth: require('./auth.js')(),
     };
     this._failFn = (message, err, argv) => {
-      const msg = err ? err.message : message;
+      const msg = err && err.message ? err.message : message;
       console.error(msg);
       if (msg === MIN_MSG || /.*Unknown argument.*/.test(msg) || /.*Not enough non-option arguments:.*/.test(msg)) {
-        console.error('\nUsage: %s', argv.help());
+        console.error('\n%s', argv.help());
       }
       process.exit(1);
     };
@@ -84,16 +116,28 @@ class CLI {
     const argv = yargs();
     Object.values(this._commands).forEach(cmd => argv.command(cmd));
 
-    return logArgs(argv)
+    const ret = logArgs(argv)
       .scriptName('hlx')
+      .usage('Usage: $0 <command> [options]')
+      .parserConfiguration({ 'camel-case-expansion': false })
+      .env('HLX')
+      .check(envAwareStrict)
+      .showHelpOnFail(true)
       .fail(this._failFn)
       .exitProcess(args.indexOf('--get-yargs-completions') > -1)
-      .strict()
       .demandCommand(1, MIN_MSG)
       .epilogue('for more information, find our manual at https://github.com/adobe/helix-cli')
       .help()
       .completion()
       .parse(args);
+
+    // hack to check if command is valid in non-strict mode
+    const cmd = ret._[0];
+    if (cmd && !(cmd in this._commands)) {
+      console.error('Unknown command: %s\n', cmd);
+      argv.showHelp();
+      process.exit(1);
+    }
   }
 }
 

src/cli.js

@@ -40,6 +40,7 @@ module.exports = function demo() {
           describe: 'Parent directory of new project',
           default: '.',
         })
+        .env('NO_HLX_ENV_SUPPORT_FOR_DEMO')
         .strict();
     },
     handler: async (argv) => {

src/defaults.js

@@ -12,7 +12,8 @@
 
 'use strict';
 
-const deployCommon = require('./deploy-common');
+const yargsOpenwhisk = require('./yargs-openwhisk.js');
+const yargsFastly = require('./yargs-fastly.js');
 const { makeLogger } = require('./log-common.js');
 
 module.exports = function deploy() {
@@ -25,34 +26,35 @@ module.exports = function deploy() {
     command: 'deploy',
     desc: 'Deploy packaged functions to Adobe I/O runtime',
     builder: (yargs) => {
-      deployCommon(yargs);
+      yargsOpenwhisk(yargs);
+      yargsFastly(yargs);
       yargs
         .option('auto', {
           describe: 'Enable auto-deployment',
           type: 'boolean',
           default: false,
           demandOption: true,
         })
+        .option('dry-run', {
+          alias: 'dryRun',
+          describe: 'List the actions that would be created, but do not actually deploy',
+          type: 'boolean',
+          default: false,
+        })
         .option('loggly-host', {
+          alias: 'logglyHost',
           describe: 'API Host for Log Appender',
           type: 'string',
           default: 'trieloff.loggly.com',
         })
         .option('loggly-auth', {
+          alias: 'logglyAuth',
           describe: 'API Key for Log Appender ($HLX_LOGGLY_AUTH)',
           type: 'string',
           default: '',
         })
-        .option('fastly-namespace', {
-          describe: 'CDN Namespace (e.g. Fastly Service ID)',
-          type: 'string',
-        })
-        .option('fastly-auth', {
-          describe: 'API Key for Fastly API ($HLX_FASTLY_AUTH)',
-          type: 'string',
-          default: '',
-        })
         .option('circleci-auth', {
+          alias: 'circleciAuth',
           describe: 'API Key for CircleCI API ($HLX_CIRCLECI_AUTH)',
           type: 'string',
           default: '',

src/demo.js

@@ -12,10 +12,6 @@
 
 'use strict';
 
-/* eslint no-console: off */
-// TODO: remove the following line
-/* eslint no-unused-vars: off */
-
 const { makeLogger } = require('./log-common.js');
 
 module.exports = function perf() {
@@ -29,14 +25,14 @@ module.exports = function perf() {
     desc: 'Test performance',
     builder: (yargs) => {
       yargs
-        .env('HLX')
-        .strict(false)
         .option('fastly-namespace', {
+          alias: 'fastlyNamespace',
           describe: 'CDN Namespace (e.g. Fastly Service ID)',
           type: 'string',
 
         })
         .option('fastly-auth', {
+          alias: 'fastlyAuth',
           describe: 'API Key for Fastly API ($HLX_FASTLY_AUTH)',
           type: 'string',
         })