improved usability with resolve() method, added names to config, bump minor version

Author: benholloway

config/app.js

@@ -5,7 +5,11 @@ var path = require('path');
 var createConfigurator = require('../lib/create-configurator'),
     listCompositions   = require('../lib/list-compositions');
 
-// TODO doctag
+/**
+ * Create a list of webpack configurators, one for each application detected.
+ * @param {{appDir:string, buildDir:string, globals:object, unminified:boolean, port:number}} options An options hash
+ * @returns {Array.<Config>} A list of configurators, one for each application detected
+ */
 function app(options) {
 
   // there may be any number of compositions in subdirectories
@@ -32,6 +36,7 @@ function app(options) {
           })
           .addMinification(!options.unminified)
           .merge({
+            name  : ['app', composition.namespace].join('::'),
             output: {
               path: path.resolve(buildDir)
             }

config/release.js

@@ -5,38 +5,41 @@ var path = require('path');
 var createConfigurator = require('../lib/create-configurator'),
     listCompositions   = require('../lib/list-compositions');
 
-// TODO doctag
+/**
+ * Create a single webpack configurator for release.
+ * @param {{appDir:string, releaseDir:string, globals:object, unminified:boolean, port:number}} options An options hash
+ * @returns {Config} A webpack configurator
+ */
 function release(options) {
   var composition = listCompositions(options.appDir)[0];
 
-  return [
-    createConfigurator({
-      addBrowserSync          : require('./add/browser-sync'),
-      addClean                : require('./add/clean'),
-      addCommon               : require('./add/common'),
-      addComposition          : require('./add/composition'),
-      addConditionals         : require('./add/conditionals'),
-      addExternalChunkManifest: require('./add/external-chunk-manifest'),
-      addMinification         : require('./add/minification')
+  return createConfigurator({
+    addBrowserSync          : require('./add/browser-sync'),
+    addClean                : require('./add/clean'),
+    addCommon               : require('./add/common'),
+    addComposition          : require('./add/composition'),
+    addConditionals         : require('./add/conditionals'),
+    addExternalChunkManifest: require('./add/external-chunk-manifest'),
+    addMinification         : require('./add/minification')
+  })
+    .addBrowserSync(options.releaseDir, options.port)
+    .addClean(options.releaseDir)
+    .addComposition(composition)
+    .addCommon(path.resolve(__dirname, '..', 'node_modules'), options.globals)
+    .addConditionals({
+      TEST   : false,
+      DEBUG  : false,
+      RELEASE: true
     })
-      .addBrowserSync(options.releaseDir, options.port)
-      .addClean(options.releaseDir)
-      .addComposition(composition)
-      .addCommon(path.resolve(__dirname, '..', 'node_modules'), options.globals)
-      .addConditionals({
-        TEST   : false,
-        DEBUG  : false,
-        RELEASE: true
-      })
-      .addExternalChunkManifest()
-      .addMinification(!options.unminified)
-      .merge({
-        output: {
-          path      : path.resolve(options.releaseDir),
-          publicPath: options.publicPath
-        }
-      })
-  ];
+    .addExternalChunkManifest()
+    .addMinification(!options.unminified)
+    .merge({
+      name  : 'release',
+      output: {
+        path      : path.resolve(options.releaseDir),
+        publicPath: options.publicPath
+      }
+    });
 }
 
 module.exports = release;

config/test.js

@@ -4,32 +4,35 @@ var path = require('path');
 
 var createConfigurator = require('../lib/create-configurator');
 
-// TODO doctag
+/**
+ * Create a single webpack configurator for test.
+ * @param {{appDir:string, testDir:string, globals:object}} options An options hash
+ * @returns {Config} A webpack configurator
+ */
 function test(options) {
   var testEntry = path.resolve(options.appDir, 'test.js');
 
-  return [
-    createConfigurator({
-      addCommon             : require('./add/common'),
-      addConditionals       : require('./add/conditionals'),
-      addTestSuiteGeneration: require('./add/test-suite-generation')
+  return createConfigurator({
+    addCommon             : require('./add/common'),
+    addConditionals       : require('./add/conditionals'),
+    addTestSuiteGeneration: require('./add/test-suite-generation')
+  })
+    .addCommon(path.resolve(__dirname, '..', 'node_modules'), options.globals)
+    .addConditionals({
+      TEST   : true,
+      DEBUG  : true,
+      RELEASE: false
     })
-      .addCommon(path.resolve(__dirname, '..', 'node_modules'), options.globals)
-      .addConditionals({
-        TEST   : true,
-        DEBUG  : true,
-        RELEASE: false
-      })
-      .addTestSuiteGeneration(testEntry, '**/*.spec.js')
-      .merge({
-        entry : {
-          test: testEntry
-        },
-        output: {
-          path: path.resolve(options.testDir)
-        }
-      })
-  ];
+    .addTestSuiteGeneration(testEntry, '**/*.spec.js')
+    .merge({
+      name  : 'test',
+      entry : {
+        test: testEntry
+      },
+      output: {
+        path: path.resolve(options.testDir)
+      }
+    });
 }
 
 module.exports = test;

index.js

@@ -9,9 +9,9 @@ var defaultOptions = require('./lib/default-options'),
     parseOptions   = require('./lib/parse-options');
 
 /**
- * Create a webpack configuration
+ * Create a set of methods that yield webpack configurator(s).
  * @param {...object} [options] Any number of options hashes to be merged
- * @returns {object} Webpack configuration
+ * @returns {{app:function, test:function, release:function, resolve:function}} A new instance
  */
 function configFactory(options) {
 
@@ -23,22 +23,38 @@ function configFactory(options) {
   // options set
   var args = Array.prototype.slice.call(arguments),
       opt  = parseOptions(
-        defaults.apply(null, [{}].concat(args)),              // merged options in
-        defaults({port: angularityPort}, defaultOptions())    // merged defaults
+        defaults.apply(null, [{}].concat(args)),            // merged options in
+        defaults({port: angularityPort}, defaultOptions())  // merged defaults
       );
 
-  // api
-  return {
-    get app() {
-      return require('./config/app')(opt);
-    },
-    get test() {
-      return require('./config/test')(opt);
-    },
-    get release() {
-      return require('./config/release')(opt);
-    }
+  // create and return the instance
+  var instance = {
+    app    : require('./config/app')(opt),
+    test   : require('./config/test')(opt),
+    release: require('./config/release')(opt),
+    resolve: resolve
   };
+  return instance;
+
+  /**
+   * Call the given function with the instance (as this) and resolve() any webpack configurators that it returns.
+   * @param {function(instance:object}:Array.<Config>|Config} fn A method to call with the instance as this
+   * @returns {Array.<object>|object} A webpack configuration or Array thereof
+   */
+  function resolve(fn) {
+    if (typeof fn !== 'function') {
+      throw new Error('The argument given to resolve() must be a function');
+    }
+    else {
+      return [].concat(fn.call(instance))
+        .filter(Boolean)
+        .map(resolveElement);
+    }
+
+    function resolveElement(configurator) {
+      return configurator.resolve();
+    }
+  }
 }
 
 module.exports = configFactory;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-angularity-solution",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Requisite configuration and modules to build Angularity projects with Webpack",
   "main": "index.js",
   "repository": {