yeoman-generator 3.1.1 → 3.2.0

package/lib/index.js

@@ -486,29 +486,42 @@ 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.
@@ -524,29 +537,54 @@ class Generator extends EventEmitter {
       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;

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.1",
+  "version": "3.2.0",
   "description": "Rails-inspired generator system that provides scaffolding for your apps",
   "homepage": "http://yeoman.io",
   "author": "Yeoman",
@@ -23,21 +23,21 @@
   ],
   "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",
+    "eslint": "^5.10.0",
+    "eslint-config-prettier": "^3.3.0",
+    "eslint-config-xo": "^0.25.1",
+    "eslint-plugin-prettier": "^3.0.0",
+    "husky": "^1.2.1",
     "inquirer": "^6.0.0",
     "jsdoc": "^3.5.5",
-    "lint-staged": "^7.2.0",
+    "lint-staged": "^8.1.0",
     "mocha": "^5.1.1",
     "mockery": "^2.1.0",
-    "nock": "^9.1.6",
-    "nyc": "^12.0.2",
-    "prettier": "^1.7.0",
+    "nock": "^10.0.4",
+    "nyc": "^13.1.0",
+    "prettier": "^1.15.3",
     "proxyquire": "^2.0.1",
-    "sinon": "^6.0.1",
+    "sinon": "^7.2.2",
     "tui-jsdoc-template": "^1.2.2",
     "yeoman-assert": "^3.1.1",
     "yeoman-test": "^1.8.0"
@@ -61,7 +61,7 @@
     "cross-spawn": "^6.0.5",
     "dargs": "^6.0.0",
     "dateformat": "^3.0.3",
-    "debug": "^3.1.0",
+    "debug": "^4.1.0",
     "detect-conflict": "^1.0.0",
     "error": "^7.0.2",
     "find-up": "^3.0.0",
@@ -72,13 +72,13 @@
     "mem-fs-editor": "^5.0.0",
     "minimist": "^1.2.0",
     "pretty-bytes": "^5.1.0",
-    "read-chunk": "^2.1.0",
+    "read-chunk": "^3.0.0",
     "read-pkg-up": "^4.0.0",
     "rimraf": "^2.6.2",
     "run-async": "^2.0.0",
     "shelljs": "^0.8.0",
     "text-table": "^0.2.0",
-    "through2": "^2.0.0",
+    "through2": "^3.0.0",
     "yeoman-environment": "^2.0.5"
   },
   "lint-staged": {