feat(cli): improve cli help/version/commands options

Author: raymondfeng

packages/cli/README.md

@@ -90,6 +90,44 @@ Options:
         --skip-install   # Do not automatically install dependencies  Default: false
 ```
 
+5. To list available commands
+
+   `lb4 --commands` (or `lb4 -l`)
+
+```sh
+Available commands:
+  lb4 app
+  lb4 extension
+  lb4 controller
+  lb4 example
+```
+
+Please note `lb4 --help` also prints out available commands.
+
+6. To print out version information
+
+   `lb4 --version` (or `lb4 -v`)
+
+```sh
+@loopback/cli version: 0.8.0
+
+@loopback/* dependencies:
+  - @loopback/authentication: ^0.8.0
+  - @loopback/boot: ^0.8.0
+  - @loopback/build: ^0.5.0
+  - @loopback/context: ^0.8.0
+  - @loopback/core: ^0.6.0
+  - @loopback/metadata: ^0.6.0
+  - @loopback/openapi-spec-builder: ^0.5.0
+  - @loopback/openapi-v3-types: ^0.4.0
+  - @loopback/openapi-v3: ^0.7.0
+  - @loopback/repository-json-schema: ^0.6.0
+  - @loopback/repository: ^0.8.0
+  - @loopback/rest: ^0.7.0
+  - @loopback/testlab: ^0.7.0
+  - @loopback/docs: ^0.5.0
+```
+
 ## Contributions
 
 - [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)

packages/cli/bin/cli.js

@@ -12,64 +12,117 @@ const debug = require('../lib/debug')();
 const minimist = require('minimist');
 const path = require('path');
 const yeoman = require('yeoman-environment');
+const PREFIX = 'loopback4:';
 
-const opts = minimist(process.argv.slice(2), {
-  alias: {
-    version: 'v',
-    commands: 'l',
-  },
-});
-
-if (opts.version) {
-  const ver = require('../package.json').version;
-  console.log('Version: %s', ver);
-  return;
+/**
+ * Parse arguments and run corresponding command
+ * @param env Yeoman env
+ * @param {*} opts Command options
+ * @param log Log function
+ * @param dryRun flag for dryRun (for testing)
+ */
+function runCommand(env, opts, log, dryRun) {
+  const args = opts._;
+  const originalCommand = args.shift();
+  let command = PREFIX + (originalCommand || 'app');
+  const supportedCommands = env.getGeneratorsMeta();
+  if (!(command in supportedCommands)) {
+    command = PREFIX + 'app';
+    args.unshift(originalCommand);
+    args.unshift(command);
+  } else {
+    args.unshift(command);
+  }
+  debug('invoking generator', args);
+  // `yo` is adding flags converted to CamelCase
+  const options = camelCaseKeys(opts, {exclude: ['--', /^\w$/, 'argv']});
+  Object.assign(options, opts);
+  debug('env.run %j %j', args, options);
+  if (!dryRun) {
+    env.run(args, options);
+  }
+  // list generators
+  if (opts.help && !originalCommand) {
+    printCommands(env, log);
+  }
 }
 
-var env = yeoman.createEnv();
+/**
+ * Set up yeoman generators
+ */
+function setupGenerators() {
+  var env = yeoman.createEnv();
+  env.register(path.join(__dirname, '../generators/app'), PREFIX + 'app');
+  env.register(
+    path.join(__dirname, '../generators/extension'),
+    PREFIX + 'extension'
+  );
+  env.register(
+    path.join(__dirname, '../generators/controller'),
+    PREFIX + 'controller'
+  );
+  env.register(
+    path.join(__dirname, '../generators/example'),
+    PREFIX + 'example'
+  );
+  return env;
+}
 
-env.register(path.join(__dirname, '../generators/app'), 'loopback4:app');
-env.register(
-  path.join(__dirname, '../generators/extension'),
-  'loopback4:extension'
-);
-env.register(
-  path.join(__dirname, '../generators/controller'),
-  'loopback4:controller'
-);
-env.register(
-  path.join(__dirname, '../generators/example'),
-  'loopback4:example'
-);
+/**
+ * Print @loopback/* versions
+ */
+function printVersions(log) {
+  const pkg = require('../package.json');
+  const ver = pkg.version;
+  log('@loopback/cli version: %s', ver);
+  const deps = pkg.config.templateDependencies;
+  log('\n@loopback/* dependencies:');
+  for (const d in deps) {
+    if (d.startsWith('@loopback/') && d !== '@loopback/cli') {
+      log('  - %s: %s', d, deps[d]);
+    }
+  }
+}
 
-// list generators
-if (opts.commands) {
-  console.log('Available commands: ');
+/**
+ * Print a list of available commands
+ * @param {*} env Yeoman env
+ * @param log Log function
+ */
+function printCommands(env, log) {
+  log('Available commands: ');
   var list = Object.keys(env.getGeneratorsMeta())
     .filter(name => /^loopback4:/.test(name))
     .map(name => name.replace(/^loopback4:/, '  lb4 '));
-  console.log(list.join('\n'));
-  return;
+  log(list.join('\n'));
 }
 
-const args = opts._;
-const originalCommand = args.shift();
-let command = 'loopback4:' + (originalCommand || 'app');
-const supportedCommands = env.getGeneratorsMeta();
+function main(opts, log, dryRun) {
+  log = log || console.log;
+  if (opts.version) {
+    printVersions(log);
+    return;
+  }
 
-if (!(command in supportedCommands)) {
-  command = 'loopback4:app';
-  args.unshift(originalCommand);
-  args.unshift(command);
-} else {
-  args.unshift(command);
-}
+  var env = setupGenerators();
 
-debug('invoking generator', args);
+  // list generators
+  if (opts.commands) {
+    printCommands(env, log);
+    return;
+  }
 
-// `yo` is adding flags converted to CamelCase
-const options = camelCaseKeys(opts, {exclude: ['--', /^\w$/, 'argv']});
-Object.assign(options, opts);
+  runCommand(env, opts, log, dryRun);
+}
+
+module.exports = main;
 
-debug('env.run %j %j', args, options);
-env.run(args, options);
+if (require.main === module) {
+  const opts = minimist(process.argv.slice(2), {
+    alias: {
+      version: 'v', // --version or -v: print versions
+      commands: 'l', // --commands or -l: print commands
+    },
+  });
+  main(opts);
+}

packages/cli/package.json

@@ -65,38 +65,34 @@
   },
   "config": {
     "templateDependencies": {
-      "//1": "This file contains dependency/version used by project templates",
-      "//2": "It can be updated by `npm run update-template-deps` under `loopback-next`",
-      "@loopback/context": "^0.8.0",
-      "@loopback/boot": "^0.8.0",
-      "@loopback/core": "^0.6.0",
-      "@loopback/rest": "^0.7.0",
-      "@loopback/openapi-v3": "^0.7.0",
-      "@loopback/build": "^0.5.0",
-      "@loopback/testlab": "^0.7.0",
       "@types/mocha": "^5.0.0",
       "@types/node": "^8.10.4",
-      "mocha": "^5.0.5",
-      "source-map-support": "^0.5.4",
-      "prettier": "^1.11.1",
-      "tslint": "^5.9.1",
-      "typescript": "^2.6.2",
       "cross-spawn": "^6.0.5",
       "debug": "^3.1.0",
-      "nyc": "^11.6.0",
+      "fs-extra": "^5.0.0",
+      "mocha": "^5.1.1",
+      "nyc": "^11.7.1",
+      "prettier": "^1.12.1",
+      "rimraf": "^2.6.2",
+      "source-map-support": "^0.5.4",
       "strong-docs": "^1.10.2",
+      "tslint": "^5.9.1",
+      "typescript": "^2.8.1",
       "@loopback/authentication": "^0.8.0",
+      "@loopback/boot": "^0.8.0",
+      "@loopback/build": "^0.5.0",
       "@loopback/cli": "^0.8.0",
+      "@loopback/context": "^0.8.0",
+      "@loopback/core": "^0.6.0",
       "@loopback/metadata": "^0.6.0",
       "@loopback/openapi-spec-builder": "^0.5.0",
-      "@loopback/openapi-spec": "^0.3.0",
       "@loopback/openapi-v3-types": "^0.4.0",
+      "@loopback/openapi-v3": "^0.7.0",
       "@loopback/repository-json-schema": "^0.6.0",
       "@loopback/repository": "^0.8.0",
-      "@loopback/openapi-v2": "^0.3.0",
-      "@loopback/docs": "^0.5.0",
-      "fs-extra": "^5.0.0",
-      "rimraf": "^2.6.2"
+      "@loopback/rest": "^0.7.0",
+      "@loopback/testlab": "^0.7.0",
+      "@loopback/docs": "^0.5.0"
     }
   },
   "copyright.owner": "IBM Corp.",

packages/cli/test/acceptance/app-run.acceptance.js

@@ -14,7 +14,7 @@ const build = require('@loopback/build');
 describe('app-generator (SLOW)', function() {
   const generator = path.join(__dirname, '../../generators/app');
   const rootDir = path.join(__dirname, '../../../..');
-  const sandbox = path.join(__dirname, '../../sandbox/sandbox-app');
+  const sandbox = path.join(rootDir, 'sandbox/sandbox-app');
   const cwd = process.cwd();
   const appName = '@loopback/sandbox-app';
   const props = {

packages/cli/test/integration/cli/cli.integration.js

@@ -0,0 +1,52 @@
+// Copyright IBM Corp. 2017,2018. All Rights Reserved.
+// Node module: @loopback/cli
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+
+const expect = require('@loopback/testlab').expect;
+const util = require('util');
+const main = require('../../../bin/cli');
+
+function getLog(buffer) {
+  buffer = buffer || [];
+  return function(format, ...params) {
+    buffer.push(util.format(format, ...params));
+    return buffer;
+  };
+}
+
+describe('cli', () => {
+  it('lists available commands', () => {
+    const entries = [];
+    main({commands: true}, getLog(entries));
+    expect(entries).to.eql([
+      'Available commands: ',
+      '  lb4 app\n  lb4 extension\n  lb4 controller\n  lb4 example',
+    ]);
+  });
+
+  it('lists versions', () => {
+    const entries = [];
+    main({version: true}, getLog(entries));
+    const logs = entries.join('');
+    expect(logs).to.match(/@loopback\/cli version\:/);
+    expect(logs).to.match(/@loopback\/\* dependencies:/);
+  });
+
+  it('prints commands with --help', () => {
+    const entries = [];
+    main({help: true, _: []}, getLog(entries));
+    expect(entries).to.containEql('Available commands: ');
+    expect(entries).to.containEql(
+      '  lb4 app\n  lb4 extension\n  lb4 controller\n  lb4 example'
+    );
+  });
+
+  it('does not print commands with --help for a given command', () => {
+    const entries = [];
+    main({help: true, _: ['app']}, getLog(entries), true);
+    expect(entries).to.not.containEql('Available commands: ');
+  });
+});