yeoman-generator 3.1.0 → 4.0.1

package/lib/actions/install.js

@@ -41,7 +41,7 @@ install.scheduleInstallTask = function(installer, paths, options, spawnOptions)
   }
 
   // Return early if we're skipping installation
-  if (this.options.skipInstall) {
+  if (this.options.skipInstall || this.options['skip-install']) {
     this.log(
       'Skipping install command: ' + chalk.yellow(installer + ' ' + args.join(' '))
     );
@@ -66,24 +66,29 @@ install.scheduleInstallTask = function(installer, paths, options, spawnOptions)
               ' is already installed, try running the following command manually: ' +
               chalk.yellow(installer + ' ' + args.join(' '))
           );
-          if (this.options.forceInstall) {
+          if (this.options.forceInstall || this.options['force-install']) {
             this.emit('error', error);
           }
+
           done();
         })
         .on('exit', (code, signal) => {
           this.emit(`${installer}Install:end`, paths);
-          if ((code || signal) && this.options.forceInstall) {
+          if (
+            (code || signal) &&
+            (this.options.forceInstall || this.options['force-install'])
+          ) {
             this.emit(
               'error',
               new Error(`Installation of ${installer} failed with code ${code || signal}`)
             );
           }
+
           done();
         });
     },
     {
-      once: installer + ' ' + args.join(' '),
+      once: installer + ' ' + args.join(' ') + ' ' + JSON.stringify(spawnOptions),
       run: false
     }
   );

package/lib/index.js

@@ -167,7 +167,7 @@ class Generator extends EventEmitter {
     questions = promptSuggestion.prefillQuestions(this.config, questions);
 
     return this.env.adapter.prompt(questions).then(answers => {
-      if (!this.options['skip-cache']) {
+      if (!this.options['skip-cache'] && !this.options.skipCache) {
         promptSuggestion.storeAnswers(this._globalConfig, questions, answers, false);
         promptSuggestion.storeAnswers(this.config, questions, answers, true);
       }
@@ -199,6 +199,7 @@ class Generator extends EventEmitter {
     if ('defaults' in config) {
       config.default = config.defaults;
     }
+
     config.description = config.description || config.desc;
 
     _.defaults(config, {
@@ -261,6 +262,7 @@ class Generator extends EventEmitter {
     if ('defaults' in config) {
       config.default = config.defaults;
     }
+
     config.description = config.description || config.desc;
 
     _.defaults(config, {
@@ -317,6 +319,7 @@ class Generator extends EventEmitter {
         parsedOpts[name] = undefined;
         return;
       }
+
       if (this._options[name] && option !== undefined) {
         parsedOpts[name] = this._options[name].type(option);
       }
@@ -486,67 +489,105 @@ class Generator extends EventEmitter {
       _.invokeMap(this._composedWith, 'run');
     });
 
-    promise.then(cb, cb);
+    // Maintain backward compatibility with the callback function
+    if (_.isFunction(cb)) {
+      promise.then(cb, cb);
+    }
+
     return promise;
   }
 
   /**
    * Compose this generator with another one.
-   * @param  {String} namespace  The generator namespace to compose with
+   * @param  {String|Object} generator  The path to the generator module or an object (see examples)
    * @param  {Object} options    The options passed to the Generator
-   * @param  {Object} [settings] Settings hash on the composition relation
-   * @param  {string} [settings.local]        Path to a locally stored generator
-   * @param  {String} [settings.link="weak"]  If "strong", the composition will occured
-   *                                          even when the composition is initialized by
-   *                                          the end user
-   * @return {this}
+   * @return {this}    This generator
    *
    * @example <caption>Using a peerDependency generator</caption>
    * this.composeWith('bootstrap', { sass: true });
    *
    * @example <caption>Using a direct dependency generator</caption>
    * this.composeWith(require.resolve('generator-bootstrap/app/main.js'), { sass: true });
+   *
+   * @example <caption>Passing a Generator class</caption>
+   * this.composeWith({ Generator: MyGenerator, path: '../generator-bootstrap/app/main.js' }, { sass: true });
    */
-  composeWith(modulePath, options) {
-    let generator;
+  composeWith(generator, options) {
+    let instantiatedGenerator;
+
+    const instantiate = (Generator, path) => {
+      Generator.resolved = require.resolve(path);
+      Generator.namespace = this.env.namespace(path);
+
+      return this.env.instantiate(Generator, {
+        options,
+        arguments: options.arguments
+      });
+    };
+
     options = options || {};
 
     // Pass down the default options so they're correctly mirrored down the chain.
     options = _.extend(
       {
-        skipInstall: this.options.skipInstall,
-        'skip-install': this.options.skipInstall,
-        skipCache: this.options.skipCache,
-        'skip-cache': this.options.skipCache,
-        forceInstall: this.options.forceInstall,
-        'force-install': this.options.forceInstall
+        skipInstall: this.options.skipInstall || this.options['skip-install'],
+        'skip-install': this.options.skipInstall || this.options['skip-install'],
+        skipCache: this.options.skipCache || this.options['skip-cache'],
+        'skip-cache': this.options.skipCache || this.options['skip-cache'],
+        forceInstall: this.options.forceInstall || this.options['force-install'],
+        'force-install': this.options.forceInstall || this.options['force-install']
       },
       options
     );
 
-    try {
-      const Generator = require(modulePath); // eslint-disable-line import/no-dynamic-require
-      Generator.resolved = require.resolve(modulePath);
-      Generator.namespace = this.env.namespace(modulePath);
-      generator = this.env.instantiate(Generator, {
-        options,
-        arguments: options.arguments
-      });
-    } catch (err) {
-      if (err.code === 'MODULE_NOT_FOUND') {
-        generator = this.env.create(modulePath, {
-          options,
-          arguments: options.arguments
-        });
-      } else {
-        throw err;
+    if (typeof generator === 'string') {
+      try {
+        const Generator = require(generator); // eslint-disable-line import/no-dynamic-require
+        instantiatedGenerator = instantiate(Generator, generator);
+      } catch (err) {
+        if (err.code === 'MODULE_NOT_FOUND') {
+          instantiatedGenerator = this.env.create(generator, {
+            options,
+            arguments: options.arguments
+          });
+        } else {
+          throw err;
+        }
       }
+    } else {
+      assert(
+        generator.Generator,
+        `${chalk.red('Missing Generator property')}\n` +
+          `When passing an object to Generator${chalk.cyan(
+            '#composeWith'
+          )} include the generator class to run in the ${chalk.cyan(
+            'Generator'
+          )} property\n\n` +
+          `this.composeWith({\n` +
+          `  ${chalk.yellow('Generator')}: MyGenerator,\n` +
+          `  ...\n` +
+          `});`
+      );
+      assert(
+        typeof generator.path === 'string',
+        `${chalk.red('path property is not a string')}\n` +
+          `When passing an object to Generator${chalk.cyan(
+            '#composeWith'
+          )} include the path to the generators files in the ${chalk.cyan(
+            'path'
+          )} property\n\n` +
+          `this.composeWith({\n` +
+          `  ${chalk.yellow('path')}: '../my-generator',\n` +
+          `  ...\n` +
+          `});`
+      );
+      instantiatedGenerator = instantiate(generator.Generator, generator.path);
     }
 
     if (this._running) {
-      generator.run();
+      instantiatedGenerator.run();
     } else {
-      this._composedWith.push(generator);
+      this._composedWith.push(instantiatedGenerator);
     }
 
     return this;
@@ -696,6 +737,7 @@ class Generator extends EventEmitter {
     if (!Array.isArray(streams)) {
       streams = [streams];
     }
+
     this._transformStreams = this._transformStreams.concat(streams);
     return this;
   }

package/lib/util/prompt-suggestion.js

@@ -36,8 +36,8 @@ const getCheckboxDefault = (question, defaultValue) => {
  * @private
  */
 const getListDefault = (question, defaultValue) => {
-  const choiceValues = question.choices.map(
-    choice => (typeof choice === 'object' ? choice.value : choice)
+  const choiceValues = question.choices.map(choice =>
+    typeof choice === 'object' ? choice.value : choice
   );
   return choiceValues.indexOf(defaultValue);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-generator",
-  "version": "3.1.0",
+  "version": "4.0.1",
   "description": "Rails-inspired generator system that provides scaffolding for your apps",
   "homepage": "http://yeoman.io",
   "author": "Yeoman",
@@ -22,25 +22,25 @@
     "app"
   ],
   "devDependencies": {
-    "coveralls": "^3.0.2",
-    "eslint": "^5.0.1",
-    "eslint-config-prettier": "^2.4.0",
-    "eslint-config-xo": "^0.23.0",
-    "eslint-plugin-prettier": "^2.2.0",
-    "husky": "^0.14.3",
-    "inquirer": "^6.0.0",
-    "jsdoc": "^3.5.5",
-    "lint-staged": "^7.2.0",
-    "mocha": "^5.1.1",
+    "coveralls": "^3.0.3",
+    "eslint": "^5.16.0",
+    "eslint-config-prettier": "^4.3.0",
+    "eslint-config-xo": "^0.26.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "husky": "^2.3.0",
+    "inquirer": "^6.3.1",
+    "jsdoc": "^3.6.2",
+    "lint-staged": "^8.1.7",
+    "mocha": "^6.1.4",
     "mockery": "^2.1.0",
-    "nock": "^9.1.6",
-    "nyc": "^12.0.2",
-    "prettier": "^1.7.0",
-    "proxyquire": "^2.0.1",
-    "sinon": "^6.0.1",
+    "nock": "^10.0.6",
+    "nyc": "^14.1.1",
+    "prettier": "^1.17.1",
+    "proxyquire": "^2.1.0",
+    "sinon": "^7.3.2",
     "tui-jsdoc-template": "^1.2.2",
     "yeoman-assert": "^3.1.1",
-    "yeoman-test": "^1.8.0"
+    "yeoman-test": "^1.9.1"
   },
   "license": "BSD-2-Clause",
   "repository": "yeoman/generator",
@@ -51,35 +51,34 @@
     "pretest": "eslint .",
     "test": "nyc mocha",
     "doc": "jsdoc -c jsdoc.json",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "precommit": "lint-staged"
+    "coverage": "nyc report --reporter=text-lcov | coveralls"
   },
   "dependencies": {
-    "async": "^2.6.0",
-    "chalk": "^2.3.0",
+    "async": "^2.6.2",
+    "chalk": "^2.4.2",
     "cli-table": "^0.3.1",
     "cross-spawn": "^6.0.5",
-    "dargs": "^6.0.0",
+    "dargs": "^6.1.0",
     "dateformat": "^3.0.3",
-    "debug": "^3.1.0",
+    "debug": "^4.1.1",
     "detect-conflict": "^1.0.0",
     "error": "^7.0.2",
     "find-up": "^3.0.0",
-    "github-username": "^4.0.0",
-    "istextorbinary": "^2.2.1",
-    "lodash": "^4.17.10",
-    "make-dir": "^1.1.0",
-    "mem-fs-editor": "^5.0.0",
+    "github-username": "^3.0.0",
+    "istextorbinary": "^2.5.1",
+    "lodash": "^4.17.11",
+    "make-dir": "^3.0.0",
+    "mem-fs-editor": "^6.0.0",
     "minimist": "^1.2.0",
-    "pretty-bytes": "^5.1.0",
-    "read-chunk": "^2.1.0",
-    "read-pkg-up": "^4.0.0",
-    "rimraf": "^2.6.2",
+    "pretty-bytes": "^5.2.0",
+    "read-chunk": "^3.2.0",
+    "read-pkg-up": "^5.0.0",
+    "rimraf": "^2.6.3",
     "run-async": "^2.0.0",
-    "shelljs": "^0.8.0",
+    "shelljs": "^0.8.3",
     "text-table": "^0.2.0",
-    "through2": "^2.0.0",
-    "yeoman-environment": "^2.0.5"
+    "through2": "^3.0.1",
+    "yeoman-environment": "^2.3.4"
   },
   "lint-staged": {
     "*.js": [
@@ -112,5 +111,10 @@
     "plugins": [
       "prettier"
     ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
   }
 }