Add Feature: strictXML Add options for working with a strict XML parser…

README.md

@@ -190,11 +190,46 @@ Results in:
 <script type="text/javascript" src="scripts/this.js"></script>
 <script type="text/javascript" src="scripts/that.js"></script>
 ```
+#### options.strictCssXML
+
+Type: `Boolean`
+Defaul: `false`
+
+Adds `/` self closure to the `link` tag to make it strict XML compliant to prevent some XML parsers from failing to properly parse and validate the document.
+
+```html
+<!-- build:css css/combined.css -->
+<link href="css/one.css" rel="stylesheet">
+<link href="css/two.css" rel="stylesheet">
+<!-- endbuild -->
+```
+
+```html
+<link rel="stylesheet" href="css/combined.css"/>
+```
+
+#### options.strictScriptXML
+
+Type: `Boolean`
+Defaul: `false`
+
+Adds `//<![CDATA[ //]]>` block to the script tag to prevent some XML parsers from changing the empty tag (`<script></script>`) into a self-closed tag (`<script />`). This can be an issue with pre-processed HTML in JSPX.
+
+```html
+<!-- build:js scripts/combined.js -->
+<script type="text/javascript" src="scripts/this.js"></script>
+<script type="text/javascript" src="scripts/that.js"></script>
+<!-- endbuild -->
+```
+
+```html
+<script type="text/javascript" src="scripts/combined.js">//<![CDATA[ //]]></script>
+```
 
 ## Contributing
 
 See the [CONTRIBUTING Guidelines](https://github.com/jonkemp/useref/blob/master/CONTRIBUTING.md)
 
 ## License
 
-MIT © [Jonathan Kemp](http://jonkemp.com)
+MIT © [Jonathan Kemp](http://jonkemp.com)

lib/refManager.js

@@ -12,6 +12,10 @@ module.exports = {
     bb.type = props.type;
     bb.attbs = props.attbs;
     bb.alternateSearchPaths = props.alternateSearchPaths;
+    bb.strictCssXML =
+    options && options.strictCssXML;
+    bb.strictScriptXML =
+    options && options.strictScriptXML;
   },
 
   transformCSSRefs: function (block, target, attbs) {
@@ -21,12 +25,21 @@ module.exports = {
     // TODO: Determine if 'href' attribute is present.
     var regcss = /<?link.*?(?:>|\))/gmi;
 
+    // end closing tag for the link element
+    var closingTag = '>';
+
     // Check to see if there are any css references at all.
     if (block.search(regcss) !== -1) {
+      if (bb && bb.strictCssXML) {
+        // make end closing tag self closing
+        // if strict XML type needed
+        closingTag = '/>';
+      }
+
       if (attbs) {
-        ref = '<link rel="stylesheet" href="' + target + '" ' + attbs + '>';
+        ref = '<link rel="stylesheet" href="' + target + '" ' + attbs + closingTag;
       } else {
-        ref = '<link rel="stylesheet" href="' + target + '">';
+        ref = '<link rel="stylesheet" href="' + target + '"' + closingTag;
       }
     }
 
@@ -40,12 +53,21 @@ module.exports = {
     // TODO: Detect 'src' attribute.
     var regscript = /<?script\(?\b[^<]*(?:(?!<\/script>|\))<[^<]*)*(?:<\/script>|\))/gmi;
 
+    // general closing for a script tag
+    var closingTag = '</script>';
+
     // Check to see if there are any js references at all.
     if (block.search(regscript) !== -1) {
+      if (bb && bb.strictScriptXML) {
+        // append cdata block to script element
+        // if strict XML type needed
+        closingTag = '//<![CDATA[ //]]>' + closingTag;
+      }
+
       if (attbs) {
-        ref = '<script src="' + target + '" ' + attbs + '></script>';
+        ref = '<script src="' + target + '" ' + attbs + '>' + closingTag;
       } else {
-        ref = '<script src="' + target + '"></script>';
+        ref = '<script src="' + target + '">' + closingTag;
       }
     }
 

test/test.js

@@ -248,4 +248,17 @@ describe('html-ref-replace', function() {
       }
     });
   });
+
+
+  it('should replace reference in css block and return replaced files', function() {
+    var result = useRef(fread(djoin('testfiles/28-strictCssXML.html')), { strictCssXML: true });
+    expect(result[0]).to.equal(fread(djoin('testfiles/28-strictCssXML-expected.html')));
+    expect(result[1]).to.eql({ css: { '/css/combined.css': { 'assets': [ '/css/one.css', '/css/two.css' ] }}});
+  });
+
+  it('should replace reference in js block and return replaced files', function() {
+    var result = useRef(fread(djoin('testfiles/29-strictScriptXML.html')), { strictScriptXML: true });
+    expect(result[0]).to.equal(fread(djoin('testfiles/29-strictScriptXML-expected.html')));
+    expect(result[1]).to.eql({ js: { 'scripts/combined.concat.min.js': { 'assets': [ 'scripts/this.js', 'scripts/that.js' ] }}});
+  });
 });

test/testfiles/16-win-expected.html

@@ -1,7 +1,7 @@
-<html>
-<head>
-	<!--[if lt IE 9]>
-	<script src="scripts/combined.js"></script>
-	<![endif]-->
-</head>
+<html>
+<head>
+	<!--[if lt IE 9]>
+	<script src="scripts/combined.js"></script>
+	<![endif]-->
+</head>
 </html>

test/testfiles/16-win.html

@@ -1,10 +1,10 @@
-<html>
-<head>
-	<!-- build:js scripts/combined.js   -->
-	<!--[if lt IE 9]>
-	<script type="text/javascript" src="scripts/this.js"></script>
-	<script type="text/javascript" src="scripts/that.js"></script>
-	<![endif]-->
-	<!-- endbuild -->
-</head>
+<html>
+<head>
+	<!-- build:js scripts/combined.js   -->
+	<!--[if lt IE 9]>
+	<script type="text/javascript" src="scripts/this.js"></script>
+	<script type="text/javascript" src="scripts/that.js"></script>
+	<![endif]-->
+	<!-- endbuild -->
+</head>
 </html>

test/testfiles/28-strictCssXML-expected.html

@@ -0,0 +1,5 @@
+<html>
+<head>
+  <link rel="stylesheet" href="/css/combined.css"/>
+</head>
+</html>

test/testfiles/28-strictCssXML.html

@@ -0,0 +1,8 @@
+<html>
+<head>
+  <!-- build:css /css/combined.css -->
+  <link href="/css/one.css" rel="stylesheet">
+  <link href="/css/two.css" rel="stylesheet">
+  <!-- endbuild -->
+</head>
+</html>

test/testfiles/29-strictScriptXML-expected.html

@@ -0,0 +1,6 @@
+<html>
+<head></head>
+<body>
+<script src="scripts/combined.concat.min.js">//<![CDATA[ //]]></script>
+</body>
+</html>

test/testfiles/29-strictScriptXML.html

@@ -0,0 +1,9 @@
+<html>
+<head></head>
+<body>
+<!-- build:js scripts/combined.concat.min.js -->
+<script type="text/javascript" src="scripts/this.js"></script>
+<script type="text/javascript" src="scripts/that.js"></script>
+<!-- endbuild -->
+</body>
+</html>