Implement registerPriorities.

Author: mshima

lib/index.js

@@ -299,98 +299,109 @@ class Generator extends EventEmitter {
 
     // Add custom queues
     if (Array.isArray(this.options.customPriorities)) {
-      const customPriorities = this.options.customPriorities.map(customPriority => {
-        // Keep backward compatibility with name
-        const newPriority = { priorityName: customPriority.name, ...customPriority };
-        delete newPriority.name;
-        return newPriority;
-      });
+      this.registerPriorities(this.options.customPriorities);
+    }
 
-      // Sort customPriorities, a referenced custom queue must be added before the one that reference it.
-      customPriorities.sort((a, b) => {
-        if (a.priorityName === b.priorityName) {
-          throw new Error(`Duplicate custom queue ${a.name}`);
-        }
+    this.compose = this.options.compose;
 
-        if (a.priorityName === b.before) {
-          return -1;
-        }
+    // Expose utilities for dependency-less generators.
+    this._ = _;
+  }
 
-        if (b.priorityName === a.before) {
-          return 1;
-        }
+  /**
+   * Register priorities for this generator
+   *
+   * @param  {Object[]} priorities - Priorities
+   * @param  {String} priorities.priorityName - Priority name
+   * @param  {String} priorities.before - The new priority will be queued before the `before` priority.
+   * @param  {String} [priorities.queueName] - Name to be used at grouped-queue
+   */
+  registerPriorities(priorities) {
+    const customPriorities = priorities.map(customPriority => {
+      // Keep backward compatibility with name
+      const newPriority = { priorityName: customPriority.name, ...customPriority };
+      delete newPriority.name;
+      return newPriority;
+    });
 
-        return 0;
-      });
+    // Sort customPriorities, a referenced custom queue must be added before the one that reference it.
+    customPriorities.sort((a, b) => {
+      if (a.priorityName === b.priorityName) {
+        throw new Error(`Duplicate custom queue ${a.name}`);
+      }
 
-      // Add queue to runLoop
-      customPriorities.forEach(customQueue => {
-        customQueue.queueName =
-          customQueue.queueName ||
-          `${this.options.namespace}#${customQueue.priorityName}`;
-        debug(`Registering custom queue ${customQueue.queueName}`);
-        this._queues[customQueue.priorityName] = customQueue;
+      if (a.priorityName === b.before) {
+        return -1;
+      }
 
-        if (this.env.runLoop.queueNames.includes(customQueue.queueName)) {
-          return;
-        }
+      if (b.priorityName === a.before) {
+        return 1;
+      }
 
-        // Backwards compatibilitiy with grouped-queue < 1.0.0
-        if (!this.env.runLoop.addSubQueue) {
-          let SubQueue;
-          try {
-            SubQueue = require('grouped-queue/lib/subqueue');
-          } catch (error) {
-            throw new Error(
-              "The running environment doesn't have the necessary features to run this generator. Update it and run again."
-            );
-          }
+      return 0;
+    });
 
-          this.env.runLoop.addSubQueue = function(name, before) {
-            if (this.__queues__[name]) {
-              // Sub-queue already exists
-              return;
-            }
+    // Add queue to runLoop
+    customPriorities.forEach(customQueue => {
+      customQueue.queueName =
+        customQueue.queueName || `${this.options.namespace}#${customQueue.priorityName}`;
+      debug(`Registering custom queue ${customQueue.queueName}`);
+      this._queues[customQueue.priorityName] = customQueue;
 
-            if (!before) {
-              // Add at last place.
-              this.__queues__[name] = new SubQueue();
-              this.queueNames.push(name);
-              return;
-            }
+      if (this.env.runLoop.queueNames.includes(customQueue.queueName)) {
+        return;
+      }
 
-            if (!this.__queues__[before] || _.indexOf(this.queueNames, before) === -1) {
-              throw new Error('sub-queue ' + before + ' not found');
-            }
+      // Backwards compatibilitiy with grouped-queue < 1.0.0
+      if (!this.env.runLoop.addSubQueue) {
+        let SubQueue;
+        try {
+          SubQueue = require('grouped-queue/lib/subqueue');
+        } catch (error) {
+          throw new Error(
+            "The running environment doesn't have the necessary features to run this generator. Update it and run again."
+          );
+        }
 
-            const current = this.__queues__;
-            const currentNames = Object.keys(current);
-            // Recreate the queue with new order.
-            this.__queues__ = {};
-            currentNames.forEach(currentName => {
-              if (currentName === before) {
-                this.__queues__[name] = new SubQueue();
-              }
+        this.env.runLoop.addSubQueue = function(name, before) {
+          if (this.__queues__[name]) {
+            // Sub-queue already exists
+            return;
+          }
 
-              this.__queues__[currentName] = current[currentName];
-            });
+          if (!before) {
+            // Add at last place.
+            this.__queues__[name] = new SubQueue();
+            this.queueNames.push(name);
+            return;
+          }
 
-            // Recreate queueNames
-            this.queueNames = Object.keys(this.__queues__);
-          };
-        }
+          if (!this.__queues__[before] || _.indexOf(this.queueNames, before) === -1) {
+            throw new Error('sub-queue ' + before + ' not found');
+          }
 
-        let beforeQueue = customQueue.before
-          ? this._queues[customQueue.before].queueName
-          : undefined;
-        this.env.runLoop.addSubQueue(customQueue.queueName, beforeQueue);
-      });
-    }
+          const current = this.__queues__;
+          const currentNames = Object.keys(current);
+          // Recreate the queue with new order.
+          this.__queues__ = {};
+          currentNames.forEach(currentName => {
+            if (currentName === before) {
+              this.__queues__[name] = new SubQueue();
+            }
 
-    this.compose = this.options.compose;
+            this.__queues__[currentName] = current[currentName];
+          });
 
-    // Expose utilities for dependency-less generators.
-    this._ = _;
+          // Recreate queueNames
+          this.queueNames = Object.keys(this.__queues__);
+        };
+      }
+
+      let beforeQueue = customQueue.before
+        ? this._queues[customQueue.before].queueName
+        : undefined;
+      this.env.runLoop.addSubQueue(customQueue.queueName, beforeQueue);
+    });
   }
 
   checkEnvironmentVersion(packageDependency, version) {