feat: added preserveComments option

remy · Dec 31, 2016 · a41ab78 · a41ab78
1 parent d53c651
commit a41ab78
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 1 deletion.
diff --git a/cli/options.js b/cli/options.js
@@ -15,6 +15,7 @@ function options(args) {
       'skip-absolute-urls',
       'videos',
       'inlinemin',
+      'preserve-comments',
     ],
     string: [ // options
       'encoding',
@@ -32,6 +33,7 @@ function options(args) {
       o: 'videos',
       m: 'inlinemin',
       H: 'header',
+      c: 'preserve-comments',
     },
   });
 
@@ -41,6 +43,10 @@ function options(args) {
     argv.compressJS = false;
     argv.collapseWhitespace = false;
   }
+  if (argv['preserve-comments']) {
+    argv.preserveComments = true;
+  }
+
   if (argv['skip-absolute-urls']) {
     argv.skipAbsoluteUrls = true;
   }

diff --git a/lib/defaults.js b/lib/defaults.js
@@ -6,5 +6,6 @@ module.exports = function () {
     collapseWhitespace: true,
     nosvg: false, // by default, DO compress SVG with SVGO
     skipAbsoluteUrls: false,
+    preserveComments: false,
   };
 };
diff --git a/lib/index.js b/lib/index.js
@@ -304,7 +304,12 @@ function main() {
 
     return Promise.all(promises).then(function then() {
       var html = '';
-      inliner.removeComments($(':root')[0], $);
+
+      // remove comments
+      if (!inliner.options.preserveComments) {
+        inliner.removeComments($(':root')[0], $);
+      }
+
       // collapse the white space
       if (inliner.options.collapseWhitespace) {
         $('pre, textarea').each(function () {

diff --git a/test/fixtures/dont-preserve-comments.opts.json b/test/fixtures/dont-preserve-comments.opts.json
@@ -0,0 +1,3 @@
+{
+  "preserveComments": false
+}
diff --git a/test/fixtures/dont-preserve-comments.result.html b/test/fixtures/dont-preserve-comments.result.html
@@ -0,0 +1 @@
+<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>inline script</title> </head> <body> </body> </html>
diff --git a/test/fixtures/dont-preserve-comments.src.html b/test/fixtures/dont-preserve-comments.src.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>inline script</title>
+</head>
+<body>
+<!-- hello -->
+</body>
+</html>
diff --git a/test/fixtures/preserve-comments.opts.json b/test/fixtures/preserve-comments.opts.json
@@ -0,0 +1,3 @@
+{
+  "preserveComments": true
+}
diff --git a/test/fixtures/preserve-comments.result.html b/test/fixtures/preserve-comments.result.html
@@ -0,0 +1 @@
+<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>inline script</title> </head> <body> <!-- hello --> </body> </html>
diff --git a/test/fixtures/preserve-comments.src.html b/test/fixtures/preserve-comments.src.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>inline script</title>
+</head>
+<body>
+<!-- hello -->
+</body>
+</html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>inline script</title> </head> <body> </body> </html>