yeoman-environment 3.16.1 → 3.17.0

package/lib/environment.js

@@ -463,7 +463,32 @@ class Environment extends Base {
    * @param  {String} packagePath - PackagePath to the generator npm package (optional)
    * @return {Object} environment - This environment
    */
-  register(name, namespace, packagePath) {
+  register(pathOrStub, meta, ...args) {
+    if (typeof pathOrStub === 'string') {
+      if (typeof meta === 'object') {
+        return this._registerGeneratorPath(pathOrStub, meta.namespace, meta.packagePath);
+      }
+      return this._registerGeneratorPath(pathOrStub, meta, ...args);
+    }
+    if (pathOrStub) {
+      if (typeof meta === 'object') {
+        return this.registerStub(pathOrStub, meta.namespace, meta.resolved, meta.packagePath);
+      }
+      return this.registerStub(pathOrStub, meta, ...args);
+    }
+    throw new TypeError('You must provide a generator name to register.');
+  }
+
+  /**
+   * Registers a specific `generator` to this environment. This generator is stored under
+   * provided namespace, or a default namespace format if none if available.
+   *
+   * @param  {String} name      - Filepath to the a generator or a npm package name
+   * @param  {String} namespace - Namespace under which register the generator (optional)
+   * @param  {String} packagePath - PackagePath to the generator npm package (optional)
+   * @return {Object} environment - This environment
+   */
+  _registerGeneratorPath(name, namespace, packagePath) {
     if (typeof name !== 'string') {
       throw new TypeError('You must provide a generator name to register.');
     }
@@ -1041,13 +1066,13 @@ class Environment extends Base {
   start(options) {
     return new Promise((resolve, reject) => {
       if (this.conflicter === undefined) {
-        const conflicterOptions = _.pick(
+        this.conflicterOptions = _.pick(
           _.defaults({}, this.options, options),
-          ['force', 'bail', 'ignoreWhitespace', 'dryRun', 'skipYoResolve', 'logCwd']
+          ['force', 'bail', 'ignoreWhitespace', 'dryRun', 'skipYoResolve', 'logCwd', 'regenerate']
         );
-        conflicterOptions.cwd = conflicterOptions.logCwd;
+        this.conflicterOptions.cwd = this.conflicterOptions.logCwd;
 
-        this.conflicter = new Conflicter(this.adapter, conflicterOptions);
+        this.conflicter = new Conflicter(this.adapter, this.conflicterOptions);
 
         this.queueConflicter();
         this.queuePackageManagerInstall();
@@ -1353,7 +1378,7 @@ class Environment extends Base {
    * @param {(...args: any[]) => void | Promise<void>} task
    * @param {{ once?: string, startQueue?: boolean }} [options]
    */
-  queueTask(priority, task, options) {
+  queueTask(priority, task, options = {}) {
     return new Promise((resolve, reject) => {
       this.runLoop.add(
         priority,

package/lib/util/conflicter.js

@@ -61,11 +61,8 @@ class Conflicter {
     let log;
     if (typeof logStatus === 'function') {
       log = logStatus;
-    } else {
-      log = this.adapter.log[logStatus];
-      if (log) {
-        log = log.bind(this.adapter.log);
-      }
+    } else if (this.adapter.log[logStatus]) {
+      log = (...args) => this.adapter.log[logStatus](...args);
     }
     if (log) {
       this.queue.add('log', done => {
@@ -86,24 +83,79 @@ class Conflicter {
       file.binary = binaryDiff.isBinary(file.path, file.contents);
     }
 
-    let args;
-    let logFunction;
     if (file.binary) {
-      logFunction = this.adapter.log.writeln.bind(this.adapter.log);
-      args = [binaryDiff.diff(file.path, file.contents)];
-    } else {
-      const existing = fs.readFileSync(file.path);
-      logFunction = this.adapter.diff.bind(this.adapter);
-      args = [
-        existing.toString(),
-        (file.contents || '').toString(),
-        file.conflicterChanges
-      ];
+      const logFunction = (...args) => this.adapter.log.writeln(...args);
+      const args = [binaryDiff.diff(file.path, file.contents)];
+      if (queue) {
+        this._log(logFunction, ...args);
+      } else {
+        logFunction(...args);
+      }
+      return;
     }
-    if (queue) {
-      this._log(logFunction, ...args);
-    } else {
-      logFunction(...args);
+
+    if (!file.conflicterChanges) {
+      throw new Error(`Changes should be available for file ${file.path}`);
+    }
+    if (this.adapter.diff) {
+      const logFunction = (...args) => this.adapter.diff(...args);
+      const args = [file.conflicterChanges];
+      if (queue) {
+        this._log(logFunction, ...args);
+      } else {
+        logFunction(...args);
+      }
+      return;
+    }
+    const logFunction = (...args) => this.adapter.log.colored(...args);
+    const colorLines = colored => {
+      if (colored.color) {
+        const lines = colored.message.split('\n');
+        const returnValue = [];
+        for (const [idx, message] of lines.entries()) {
+          // Empty message can be ignored
+          if (message) {
+            returnValue.push({message, color: colored.color});
+          }
+
+          if (idx + 1 < lines.length) {
+            returnValue.push({message: '\n'});
+          }
+        }
+
+        return returnValue;
+      }
+
+      return [colored];
+    };
+
+    if (file.conflicterChanges) {
+      const messages = file.conflicterChanges.map(change => {
+        if (change.added) {
+          return {color: 'added', message: change.value};
+        }
+
+        if (change.removed) {
+          return {color: 'removed', message: change.value};
+        }
+
+        return {message: change.value};
+      })
+        .map(colored => colorLines(colored));
+
+      const args = [
+        {message: '\n'},
+        {message: 'removed', color: 'removed'},
+        {message: 'added', color: 'added'},
+        {message: '\n\n'},
+        ...messages.flat(),
+        {message: '\n\n'}
+      ];
+      if (queue) {
+        this._log(logFunction, args);
+      } else {
+        logFunction(args);
+      }
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-environment",
-  "version": "3.16.1",
+  "version": "3.17.0",
   "description": "Handles the lifecyle and bootstrapping of generators in a specific environment",
   "homepage": "http://yeoman.io",
   "author": "Yeoman",