Merge pull request #194 from donejs/keep-comment

matthewp · web-flow · commit 649831cb4909 · 2018-10-30T08:17:07.000-04:00
Leave in comments starting with autorender-keep
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,5 @@
 language: node_js
-node_js: node
+node_js: 10.7
 script: npm test
 addons:
   firefox: "51.0"
diff --git a/src/template.js b/src/template.js
diff --git a/src/template.txt b/src/template.txt
@@ -105,6 +105,18 @@ define(<%= imports %>, function(<%= args %>){
 		"BASE": true
 	};
 
+	function hasDataKeepAttr(node) {
+		return node.dataset && node.dataset.keep === "";
+	}
+
+	function isKeepComment(node) {
+		return node.nodeType === 8 && node.nodeValue.indexOf("autorender-keep") === 0;
+	}
+
+	function isKeepNode(node) {
+		return hasDataKeepAttr(node) || isKeepComment(node);
+	}
+
 	/**
 	 * Call a callback for each child Node within a parent, skipping
 	 * elements that should not be touched because of their side-effects.
@@ -117,7 +129,7 @@ define(<%= imports %>, function(<%= args %>){
 		for(; i < len; i++) {
 			node = nodes[i];
 			ignoreTag = tagsToIgnore[node.nodeName];
-			if(!ignoreTag && !(node.dataset && node.dataset.keep === "")) {
+			if(!ignoreTag && !isKeepNode(node)) {
 				// Returning false breaks the loop
 				if(callback(node) === false) {
 					break;
diff --git a/test/autorender_test.js b/test/autorender_test.js
@@ -36,6 +36,21 @@ QUnit.test("basics works", function(){
 
 QUnit.test("elements marked with data-keep are left in the DOM", function(){
 	F("[name='custom-meta']").exists("meta tag left in");
+	F(function() {
+		var hasComment = false;
+		var head = F.win.document.head;
+		var child = head.firstChild;
+		while(child) {
+			if(child.nodeType === 8) {
+				if(child.nodeValue === "autorender-keep some comment") {
+					hasComment = true;
+					break;
+				}
+			}
+			child = child.nextSibling;
+		}
+		QUnit.equal(hasComment, true, "Comments with autorender-keep are left in.");
+	})
 });
 
 QUnit.module("tags to ignore from head", {
diff --git a/test/basics/index.html b/test/basics/index.html
@@ -1,6 +1,7 @@
 <html>
 <head>
 	<meta name="custom-meta" content="some value" data-keep>
+	<!--autorender-keep some comment-->
 </head>
 <body>
 	<script src="../../node_modules/steal/steal.js" main="test/basics/index.stache!done-autorender"></script>
