Fixes #613, option to write out bundles config

Author: jrburke

.gitignore

@@ -7,6 +7,7 @@ build/tests/lib/amdefine/built.js
 build/tests/lib/anonUmdInteriorModules/main-built.js
 build/tests/lib/appDirSrcOverwrite/www-built
 build/tests/lib/arrow/main-built.js
+build/tests/lib/bundlesConfig/built
 build/tests/lib/cjsTranslate/www-built
 build/tests/lib/closureExterns/built
 build/tests/lib/comments/built.js

build/example.build.js

@@ -638,6 +638,18 @@
     //set "keepBuildDir" to true.
     allowSourceOverwrites: false,
 
+    //Introduced in 2.2.0. Path to file to write out bundles config
+    //(http://requirejs.org/docs/api.html#config-bundles) found in the module
+    //layers built by the optimizer. The path is relative to the "dir" config's
+    //path. Only applies to full project optimization:
+    //http://requirejs.org/docs/optimization.html#wholeproject
+    //Only use if the optimized layers are grouped more intricately then just
+    //a simple optimization of main app entry points. The file path specified
+    //should be to one that has the top level requirejs.config() call that sets
+    //up the loader. If using "mainConfigFile", then this path likely should be
+    //the path to that file where it is placed in the "dir" output directory.
+    bundlesConfigOutFile: 'some/path/to/main.js',
+
     //Introduced in 2.2.0. Default is true for compatibility with older
     //releases. If set to false, r.js will not write a build.txt file in the
     //"dir" directory when doing a full project optimization.

build/jslib/build.js

@@ -564,17 +564,36 @@ define(function (require) {
                 }));
             }
         }).then(function () {
-            var moduleName, outOrigSourceMap;
+            var moduleName, outOrigSourceMap,
+                bundlesConfig = {},
+                bundlesConfigOutFile = config.bundlesConfigOutFile;
+
             if (modules) {
                 //Now move the build layers to their final position.
                 modules.forEach(function (module) {
-                    var finalPath = module._buildPath;
+                    var entryConfig,
+                        finalPath = module._buildPath;
+
                     if (finalPath !== 'FUNCTION') {
                         if (file.exists(finalPath)) {
                             file.deleteFile(finalPath);
                         }
                         file.renameFile(finalPath + '-temp', finalPath);
 
+                        //If bundles config should be written out, scan the
+                        //built file for module IDs. Favor doing this reparse
+                        //since tracking the IDs as the file is built has some
+                        //edge cases around files that had more than one ID in
+                        //them already, and likely loader plugin-written contents.
+                        if (bundlesConfigOutFile) {
+                            entryConfig = bundlesConfig[module.name] = [];
+                            var bundleContents = file.readFile(finalPath);
+                            var excludeMap = {};
+                            excludeMap[module.name] = true;
+                            var parsedIds = parse.getAllNamedDefines(bundleContents, excludeMap);
+                            entryConfig.push.apply(entryConfig, parsedIds);
+                        }
+
                         //And finally, if removeCombined is specified, remove
                         //any of the files that were used in this layer.
                         //Be sure not to remove other build layers.
@@ -601,6 +620,24 @@ define(function (require) {
                         config.onModuleBundleComplete(module.onCompleteData);
                     }
                 });
+
+                //Write out bundles config, if it is wanted.
+                if (bundlesConfigOutFile) {
+                    var text = file.readFile(bundlesConfigOutFile);
+                    text = transform.modifyConfig(text, function (config) {
+                        if (!config.bundles) {
+                            config.bundles = {};
+                        }
+
+                        lang.eachProp(bundlesConfig, function (value, prop) {
+                            config.bundles[prop] = value;
+                        });
+
+                        return config;
+                    });
+
+                    file.saveUtf8File(bundlesConfigOutFile, text);
+                }
             }
 
             //If removeCombined in play, remove any empty directories that
@@ -1287,6 +1324,13 @@ define(function (require) {
             config.dirBaseUrl = endsWithSlash(config.dirBaseUrl);
         }
 
+        if (config.bundlesConfigOutFile) {
+            if (!config.dir) {
+                throw new Error('bundlesConfigOutFile can only be used with optimizations ' +
+                                'that use "dir".');
+            }
+            config.bundlesConfigOutFile = build.makeAbsPath(config.bundlesConfigOutFile, config.dir);
+        }
 
         //If out=stdout, write output to STDOUT instead of a file.
         if (config.out && config.out === 'stdout') {

build/jslib/parse.js

@@ -677,6 +677,33 @@ define(['./esprimaAdapter', 'lang'], function (esprima, lang) {
         return name;
     };
 
+    /**
+     * Finds all the named define module IDs in a file.
+     */
+    parse.getAllNamedDefines = function (fileContents, excludeMap) {
+        var names = [];
+        parse.recurse(esprima.parse(fileContents),
+        function (callName, config, name, deps, node, factoryIdentifier, fnExpScope) {
+            if (callName === 'define' && name) {
+                if (!excludeMap.hasOwnProperty(name)) {
+                    names.push(name);
+                }
+            }
+
+            //If a UMD definition that points to a factory that is an Identifier,
+            //indicate processing should not traverse inside the UMD definition.
+            if (callName === 'define' && factoryIdentifier && hasProp(fnExpScope, factoryIdentifier)) {
+                return factoryIdentifier;
+            }
+
+            //If define was found, no need to dive deeper, unless
+            //the config explicitly wants to dig deeper.
+            return true;
+        }, {});
+
+        return names;
+    };
+
     /**
      * Determines if define(), require({}|[]) or requirejs was called in the
      * file. Also finds out if define() is declared and if define.amd is called.

build/tests/builds.js

@@ -2810,4 +2810,23 @@ define(['build', 'env!env/file', 'env', 'lang'], function (build, file, env, lan
         }
     ]);
     doh.run();
+
+    //Test writing bundles config.
+    //See https://github.com/requirejs/r.js/issues/613
+    doh.register("writeBundlesConfig",
+        [
+            function writeBundlesConfig(t) {
+                file.deleteFile("lib/bundlesConfig/built");
+
+                build(["lib/bundlesConfig/build.js"]);
+
+                t.is(nol(c("lib/bundlesConfig/expected.js")),
+                     nol(c("lib/bundlesConfig/built/main.js")));
+                require._buildReset();
+            }
+
+        ]
+    );
+    doh.run();
+
 });