Update to support require.config to match amdjs require API doc.

jrburke · jrburke · commit 7cab037f3f98 · 2011-08-15T18:45:45.000-07:00
diff --git a/docs/api.html b/docs/api.html
@@ -528,22 +528,21 @@ <h2>
 
 <pre><code>&lt;script type="text/javascript" src="scripts/require.js"&gt;&lt;/script&gt;
 &lt;script type="text/javascript"&gt;
-  require({
-          baseUrl: "/another/path",
-          paths: {
-              "some": "some/v1.0"
-          },
-          waitSeconds: 15,
-          locale: "fr-fr",
-          context: "foo"
-      },
-      ["some/module", "my/module", "a.js", "b.js"],
-      function(someModule, myModule) {
-          //This function will be called when all the dependencies
-          //listed above are loaded. Note that this function could
-          //be called before the page is loaded.
-          //This callback is optional.
-      }
+  require.config({
+    baseUrl: "/another/path",
+    paths: {
+        "some": "some/v1.0"
+    },
+    waitSeconds: 15,
+    locale: "fr-fr"
+  });
+  require( ["some/module", "my/module", "a.js", "b.js"],
+    function(someModule,    myModule) {
+        //This function will be called when all the dependencies
+        //listed above are loaded. Note that this function could
+        //be called before the page is loaded.
+        //This callback is optional.
+    }
   );
 &lt;/script&gt;
 </code></pre>
@@ -585,7 +584,7 @@ <h2>
 
 <p id="config-locale"><strong>locale</strong>: The locale to use for loading i18n bundles. By default navigator.language or navigator.userLanguage will be used. The proper syntax for specifying a locale is using lowercase and separating values by dashes, for instance: "fr-fr-paris" or "en-us".</p>
 
-<p id="config-context"><strong>context</strong>: A name to give to a loading context. This allows require.js to load multiple versions of modules in a page, as long as each top-level require call specifies a unique context string. See <strong>Advanced Features</strong> below.</p>
+<p id="config-context"><strong>context</strong>: A name to give to a loading context. This allows require.js to load multiple versions of modules in a page, as long as each top-level require call specifies a unique context string. To use it correctly, see the <a href="#multiversion">Multiversion Support</strong> section.</p>
 
 <p id="config-deps"><strong>deps</strong>: An array of dependencies to load. Useful when require is defined as a config object before require.js is loaded, and you want to specify dependencies to load as soon as require() is defined.</p>
 
@@ -738,7 +737,7 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 
 <pre><code>//main.js contents
 //Pass a config object to require
-require({
+require.config({
     packagePaths: {
         ".packages": ["alpha", "omega"]
     },
@@ -791,7 +790,7 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 
 <p>Then the RequireJS configuration would look like so:</p>
 
-<pre><code>require({
+<pre><code>require.config({
     packagePaths: {
         ".packages": [
             {
@@ -813,7 +812,7 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 
 <p><strong>packagePaths</strong> is just a convenience for listing several packages that are not direct siblings of require.js, but still have a common directory parent. The above configuration could be written like so with just the <strong>packages</strong> config option, by using the <strong>location</strong> property for each third-party package:</p>
 
-<pre><code>require({
+<pre><code>require.config({
     "packages": [
         {
             name: "alpha",
@@ -839,49 +838,49 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 
 <h3><a name="multiversion">Multiversion Support</a><span class="sectionMark">&sect; 5.2</span></h3>
 
-<p>As mentioned in <a href="#config">Configuration Options</a>, multiple versions of a module can be loaded in a page by using different "context" configuration options. Here is an example that loads two different versions of the alpha and beta modules (this example is taken from one of the test files):</p>
+<p>As mentioned in <a href="#config">Configuration Options</a>, multiple versions of a module can be loaded in a page by using different "context" configuration options. require.config() returns a require function that will use the context configuration. Here is an example that loads two different versions of the alpha and beta modules (this example is taken from one of the test files):</p>
 
 <pre><code>&lt;script type="text/javascript" src="../require.js"&gt;&lt;/script&gt;
 &lt;script type="text/javascript"&gt;
-require({
-      context: "version1",
-      baseUrl: "version1"
-    },
-    ["require", "alpha", "beta",],
-    function(require, alpha, beta) {
-      log("alpha version is: " + alpha.version); //prints 1
-      log("beta version is: " + beta.version); //prints 1
-
-      setTimeout(function() {
-        require(["omega"],
-          function(omega) {
-            log("version1 omega loaded with version: " +
-                omega.version); //prints 1
-          }
-        );
-      }, 100);
-    }
-);
+var reqOne = require.config({
+  context: "version1",
+  baseUrl: "version1"
+});
+
+reqOne(["require", "alpha", "beta",],
+function(require,   alpha,   beta) {
+  log("alpha version is: " + alpha.version); //prints 1
+  log("beta version is: " + beta.version); //prints 1
 
-require({
+  setTimeout(function() {
+    require(["omega"],
+      function(omega) {
+        log("version1 omega loaded with version: " +
+             omega.version); //prints 1
+      }
+    );
+  }, 100);
+});
+
+var reqTwo = require.config({
       context: "version2",
       baseUrl: "version2"
-    },
-    ["require", "alpha", "beta"],
-    function(require, alpha, beta) {
-      log("alpha version is: " + alpha.version); //prints 2
-      log("beta version is: " + beta.version); //prints 2
-
-      setTimeout(function() {
-        require(["omega"],
-          function(omega) {
-            log("version2 omega loaded with version: " +
-                omega.version); //prints 2
-          }
-        );
-      }, 100);
+    });
+
+reqTwo(["require", "alpha", "beta"],
+function(require,   alpha,   beta) {
+  log("alpha version is: " + alpha.version); //prints 2
+  log("beta version is: " + beta.version); //prints 2
+
+  setTimeout(function() {
+    require(["omega"],
+      function(omega) {
+        log("version2 omega loaded with version: " +
+            omega.version); //prints 2
       }
-);
+    );
+  }, 100);
+});
 &lt;/script&gt;
 </code></pre>
 
diff --git a/docs/faq-optimization.html b/docs/faq-optimization.html
@@ -77,7 +77,7 @@ <h2><a name="priority">How can I download all script dependencies in parallel?</
         &lt;title&gt;Page 1&lt;/title&gt;
         &lt;script src="scripts/require.js"&gt;&lt;/script&gt;
         &lt;script&gt;
-            require({
+            require.config({
                 priority: ["appcommon", "page1"]
             });
         &lt;/script&gt;
diff --git a/docs/optimization.html b/docs/optimization.html
@@ -168,13 +168,14 @@ <h2><a name="shallow">Shallow exclusions for fast development</a><span class="se
         &lt;link rel="stylesheet" type="text/css" href="css/main.css"&gt;
         &lt;script src="scripts/require.js"&gt;&lt;/script&gt;
         &lt;script&gt;
-            require({
+            require.config({
                 paths: {
                     //Comment out this line to go back to loading
                     //the non-optimized main.js source file.
                     "main": "main-built"
                 }
-            }, ["main"]);
+            });
+            require(["main"]);
         &lt;/script&gt;
     &lt;/head&gt;
     &lt;body&gt;
diff --git a/require.js b/require.js
@@ -1270,7 +1270,7 @@ var requirejs, require, define;
                         resume();
                     }
                 }
-                return undefined;
+                return context.require;
             },
 
             /**
@@ -1482,6 +1482,14 @@ var requirejs, require, define;
         return context.require(deps, callback);
     };
 
+    /**
+     * Support require.config() to make it easier to cooperate with other
+     * AMD loaders on globally agreed names.
+     */
+    req.config = function (config) {
+        return req(config);
+    };
+
     /**
      * Export require as a global, but only if it does not already exist.
      */
diff --git a/tasks.txt b/tasks.txt
@@ -8,27 +8,18 @@ Release Notes
 Next release
 --------------
 
-- Document catchError: define
-
-- Document require for amd list
-
 - programmable builds, web server builds, hmm web build not work on reload?
   need to document.
+- document pragmasOnSave
 
-- Node 0.5.3 running ./alln.sh in r.js fails:
-Error: require.paths is removed. Use node_modules folders, or the NODE_PATH environment variable instead.
-    at Function.<anonymous> (module.js:360:11)
-Figure out a better way, use a module that can be included: var r = require("r"); This
-would allow the directory to be the directory of the script...
+- A way to support local file/other kinds of caches?
+http://groups.google.com/group/requirejs/browse_thread/thread/77092307ac6b9acb
+http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-filesystemurls
 
 - Update docs to mention npm install option for r.js: requirejs package, document use,
 switch to new docs for running node apps vs. doing the optimization:
   require('requirejs') vs r.js -o .....
 
-- Error messages not having useful lineNumber and fileName in Chrome:
-  https://github.com/jrburke/requirejs/issues/116
-
-
 Docs:
 - rename r.js to be another name, confusing as a shorthand for require.js?
 
diff --git a/tests/exports/exports-tests.js b/tests/exports/exports-tests.js
@@ -1,6 +1,8 @@
-require({
-        baseUrl: require.isBrowser ? "./" : "./exports/"
-    },
+require.config({
+    baseUrl: require.isBrowser ? "./" : "./exports/"
+});
+
+require(
     ["require", "vanilla", "funcSet", "assign", "assign2", "usethis",
      "implicitModule", "simpleReturn"],
     function(require, vanilla, funcSet, assign, assign2, usethis,
diff --git a/tests/multiversion.html b/tests/multiversion.html
@@ -49,11 +49,11 @@
 			    }
 			);
 
-			require(
+			require.config(
 			    {
 				context: "version2",
 				baseUrl: "version2/"
-			    },
+			    })(
 			    ["require", "alpha", "beta", "version2/epsilon.js"],
 			    function(require, alpha, beta) {
 				//Notice no module arg name for epsilon in the function call.
@@ -72,8 +72,7 @@
 					}
 				    );
 				}, 100);
-			    }
-			);
+			    });
 
 			return master;
 		    }
diff --git a/tests/text/text.html b/tests/text/text.html
@@ -7,11 +7,12 @@
     <script type="text/javascript" src="../doh/_browserRunner.js"></script>
     <script type="text/javascript">
     require({
-            baseUrl: "./",
-            paths: {
-                text: "../../text"
-            } //, priority: ['widgetlayer']
-        },
+        baseUrl: "./",
+        paths: {
+            text: "../../text"
+        } //, priority: ['widgetlayer']
+    });
+    require(
         ["require", "widget", "local", "text!resources/sample.html!strip"],
         function(require, widget, local, sampleText) {
             doh.register(

Original file line number	Diff line number	Diff line change
`@@ -49,11 +49,11 @@`
`49`	`49`	`}`
`50`	`50`	`);`
`51`	`51`
`52`		`- require(`
	`52`	`+ require.config(`
`53`	`53`	`{`
`54`	`54`	`context: "version2",`
`55`	`55`	`baseUrl: "version2/"`
`56`		`- },`
	`56`	`+ })(`
`57`	`57`	`["require", "alpha", "beta", "version2/epsilon.js"],`
`58`	`58`	`function(require, alpha, beta) {`
`59`	`59`	`//Notice no module arg name for epsilon in the function call.`
`@@ -72,8 +72,7 @@`
`72`	`72`	`}`
`73`	`73`	`);`
`74`	`74`	`}, 100);`
`75`		`- }`
`76`		`- );`
	`75`	`+ });`
`77`	`76`
`78`	`77`	`return master;`
`79`	`78`	`}`