help tests cleanup

kellyselden · Sep 27, 2015 · 732bb38 · 732bb38
1 parent 68a772f
commit 732bb38
Show file tree

Hide file tree

Showing 33 changed files with 1,993 additions and 2,940 deletions.
diff --git a/lib/commands/generate.js b/lib/commands/generate.js
@@ -210,7 +210,7 @@ module.exports = Command.extend({
             output += ' ' + chalk.cyan('(Required)');
           }
 
-          if (opt.aliases) {
+          if (opt.aliases && opt.aliases.length) {
             output += EOL + '          ' + chalk.grey('aliases: ' + opt.aliases.map(function(a) {
               var key;
               if (typeof a === 'string') {

diff --git a/lib/commands/help.js b/lib/commands/help.js
@@ -55,7 +55,7 @@ module.exports = Command.extend({
 
       Object.keys(this.commands).forEach(function(commandName) {
         if (commandOptions.json) {
-          this._addCommandHelpToJson(commandName, commandOptions, json);
+          this._addCommandHelpToJson(commandName, false, commandOptions, json);
         } else {
           this._printBasicHelpForCommand(commandName, commandOptions);
         }
@@ -75,7 +75,7 @@ module.exports = Command.extend({
           }
           Object.keys(this.commands).forEach(function(commandName) {
             if (commandOptions.json) {
-              this._addCommandHelpToJson(commandName, commandOptions, addonJson);
+              this._addCommandHelpToJson(commandName, false, commandOptions, addonJson);
             } else {
               this._printBasicHelpForCommand(commandName, commandOptions);
             }
@@ -103,7 +103,7 @@ module.exports = Command.extend({
           commandOptions.rawArgs = rawArgs;
         }
         if (commandOptions.json) {
-          this._addCommandHelpToJson(command, commandOptions, json);
+          this._addCommandHelpToJson(command, true, commandOptions, json);
         } else {
           this._printDetailedHelpForCommand(command, commandOptions);
         }
@@ -112,7 +112,7 @@ module.exports = Command.extend({
         // and try to display usage instructions.
         rawArgs.forEach(function(commandName) {
           if (commandOptions.json) {
-            this._addCommandHelpToJson(commandName, commandOptions, json);
+            this._addCommandHelpToJson(commandName, true, commandOptions, json);
           } else {
             this._printDetailedHelpForCommand(commandName, commandOptions);
           }
@@ -125,9 +125,9 @@ module.exports = Command.extend({
     }
   },
 
-  _addCommandHelpToJson: function(commandName, options, json) {
+  _addCommandHelpToJson: function(commandName, single, options, json) {
     var command = this._lookupCommand(commandName);
-    if (!command.skipHelp) {
+    if (!command.skipHelp || single) {
       json.commands.push(command.getJson(options));
     }
   },
@@ -143,7 +143,7 @@ module.exports = Command.extend({
   _printHelpForCommand: function(commandName, detailed, options) {
     var command = this._lookupCommand(commandName);
 
-    if (!command.skipHelp || (command.skipHelp && detailed)) {
+    if (!command.skipHelp || detailed) {
       command.printBasicHelp(options);
     }
 

diff --git a/lib/models/blueprint.js b/lib/models/blueprint.js
@@ -21,6 +21,7 @@ var uniq                = require('lodash/array/uniq');
 var zipObject           = require('lodash/array/zipObject');
 var contains            = require('lodash/collection/contains');
 var any                 = require('lodash/collection/some');
+var cloneDeep           = require('lodash/lang/cloneDeep');
 var keys                = require('lodash/object/keys');
 var merge               = require('lodash/object/merge');
 var values              = require('lodash/object/values');
@@ -1239,7 +1240,7 @@ Blueprint.prototype.printDetailedHelp = function() {
   var filePath = this._getDetailedHelpPath();
 
   if (existsSync(filePath)) {
-    return markdownColor.renderFile(filePath, {indent:'        '});
+    return markdownColor.renderFile(filePath, { indent: '        ' });
   }
   return '';
 };
@@ -1249,7 +1250,16 @@ Blueprint.prototype.getJson = function(verbose) {
 
   printableProperties.forEach(function(key) {
     if (this[key] !== undefined) {
-      json[key] = this[key];
+      var value = this[key];
+      if (key === 'availableOptions') {
+        value = cloneDeep(value);
+        value.forEach(function(option) {
+          if (typeof option.type === 'function') {
+            option.type = option.type.name;
+          }
+        });
+      }
+      json[key] = value;
     }
   }, this);
 

diff --git a/tests/acceptance/help-test.js b/tests/acceptance/help-test.js
diff --git a/tests/helpers/command-names.js b/tests/helpers/command-names.js
diff --git a/tests/unit/commands/destroy-test.js b/tests/unit/commands/destroy-test.js
@@ -1,11 +1,15 @@
+/*jshint multistr: true */
+
 'use strict';
 
-var expect         = require('chai').expect;
-var MockProject    = require('../../helpers/mock-project');
-var commandOptions = require('../../factories/command-options');
-var Promise        = require('../../../lib/ext/promise');
-var Task           = require('../../../lib/models/task');
-var DestroyCommand = require('../../../lib/commands/destroy');
+var expect            = require('chai').expect;
+var EOL               = require('os').EOL;
+var MockProject       = require('../../helpers/mock-project');
+var processHelpString = require('../../helpers/process-help-string');
+var commandOptions    = require('../../factories/command-options');
+var Promise           = require('../../../lib/ext/promise');
+var Task              = require('../../../lib/models/task');
+var DestroyCommand    = require('../../../lib/commands/destroy');
 
 describe('generate command', function() {
   var options, command;
@@ -90,4 +94,17 @@ describe('generate command', function() {
       expect(error.message).to.equal('undefined is not a function');
     });
   });
+
+  describe('help', function() {
+    it('prints extra info', function() {
+      command.printDetailedHelp();
+
+      var output = options.ui.output;
+
+      var testString = processHelpString(EOL + '\
+  Run `ember help generate` to view a list of available blueprints.' + EOL);
+
+      expect(output).to.equal(testString);
+    });
+  });
 });