Preserve license comments in built file. Closes requirejs#41

jrburke · jrburke · commit d6553d518f4f · 2011-11-21T15:00:54.000-08:00
Finds all license comments and puts them at the top of the minified file.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
 .DS_Store
 r.js
 build/tests/builds
+build/tests/lib/comments/built.js
+build/tests/lib/empty/built
 build/tests/lib/namespace/foo.js
 build/tests/lib/plugins/main-built.js
 build/tests/lib/dotpackage/built
diff --git a/build/jslib/optimize.js b/build/jslib/optimize.js
@@ -128,6 +128,8 @@ function (lang,   logger,   envOptimize,        file,           parse,
     }
 
     optimize = {
+        licenseCommentRegExp: /\/\*[\s\S]*?\*\//g,
+
         /**
          * Optimizes a file that contains JavaScript content. Optionally collects
          * plugin resources mentioned in a file, and then passes the content
@@ -146,7 +148,8 @@ function (lang,   logger,   envOptimize,        file,           parse,
             var parts = (config.optimize + "").split('.'),
                 optimizerName = parts[0],
                 keepLines = parts[1] === 'keepLines',
-                fileContents, optFunc, deps, i, dep;
+                licenseContents = '',
+                fileContents, optFunc, match, comment;
 
             fileContents = file.readFile(fileName);
 
@@ -161,7 +164,19 @@ function (lang,   logger,   envOptimize,        file,           parse,
                                     optimizerName +
                                     '" not found for this environment');
                 }
-                fileContents = optFunc(fileName, fileContents, keepLines,
+
+                //Pull out any license comments for prepending after optimization.
+                optimize.licenseCommentRegExp.lastIndex = 0;
+                while ((match = optimize.licenseCommentRegExp.exec(fileContents))) {
+                    comment = match[0];
+                    //Only keep the comments if they are license comments.
+                    if (comment.indexOf('@license') !== -1 ||
+                        comment.indexOf('/*!') === 0) {
+                        licenseContents += comment + '\n';
+                    }
+                }
+
+                fileContents = licenseContents + optFunc(fileName, fileContents, keepLines,
                                         config[optimizerName]);
             }
 
diff --git a/build/tests/builds.js b/build/tests/builds.js
@@ -259,5 +259,22 @@ define(['build', 'env!env/file'], function (build, file) {
     );
     doh.run();
 
+    doh.register("preserveLicense",
+        [
+            function preserveLicense(t) {
+                file.deleteFile("lib/comments/built.js");
+
+                build(["lib/comments/build.js"]);
+
+                t.is(nol(c("lib/comments/expected.js")),
+                     nol(c("lib/comments/built.js")));
+
+                require._buildReset();
+            }
+
+        ]
+    );
+    doh.run();
+
 
 });
diff --git a/build/tests/lib/comments/bang.js b/build/tests/lib/comments/bang.js
@@ -0,0 +1,10 @@
+/*!
+ * this is a BANG LICENSE COMMENT
+ */
+
+define(function () {
+    /* This comment should be IGNORED */
+    return {
+        name: 'bang'
+    };
+});
diff --git a/build/tests/lib/comments/build.js b/build/tests/lib/comments/build.js
@@ -0,0 +1,6 @@
+({
+    baseUrl: '.',
+    name: 'bang',
+    include: ['license'],
+    out: 'built.js'
+})
diff --git a/build/tests/lib/comments/expected.js b/build/tests/lib/comments/expected.js
@@ -0,0 +1,9 @@
+/*!
+ * this is a BANG LICENSE COMMENT
+ */
+/** vim: et:ts=4:sw=4:sts=4
+ * @license This is a  LICENSE COMMENT that should be preserved.
+ * Available via the MIT or new BSD license.
+ * see: http://example.com/license for details
+ */
+define("bang",[],function(){return{name:"bang"}}),define("license",{name:"license"})
diff --git a/build/tests/lib/comments/license.js b/build/tests/lib/comments/license.js
@@ -0,0 +1,13 @@
+/** vim: et:ts=4:sw=4:sts=4
+ * @license This is a  LICENSE COMMENT that should be preserved.
+ * Available via the MIT or new BSD license.
+ * see: http://example.com/license for details
+ */
+
+define({
+    //@license comment to be IGNORED
+    name: 'license'
+    /**
+     * A license fake-out, should be IGNORED
+     */
+});
