Merge pull request #1764 from Shopify/fix-comment-tag-whitespace-control

implement whitespace control to comment tag

lib/liquid/tags/comment.rb

@@ -73,7 +73,10 @@ module Liquid
           when "endcomment"
             comment_tag_depth -= 1
 
-            return false if comment_tag_depth.zero?
+            if comment_tag_depth.zero?
+              parse_context.trim_whitespace = (token[-3] == WhitespaceControl)
+              return false
+            end
           end
         end
 

test/unit/tags/comment_tag_unit_test.rb

@@ -155,4 +155,15 @@ class CommentTagUnitTest < Minitest::Test
     assert_template_result('', "{% comment %}123{% endcomment\nxyz %}")
     assert_template_result('', "{% comment %}123{% endcomment\n   xyz  endcomment %}")
   end
+
+  def test_with_whitespace_control
+    assert_template_result("Hello!", "      {%- comment -%}123{%- endcomment -%}Hello!")
+    assert_template_result("Hello!", "{%- comment -%}123{%- endcomment -%}     Hello!")
+    assert_template_result("Hello!", "      {%- comment -%}123{%- endcomment -%}     Hello!")
+
+    assert_template_result("Hello!", <<~LIQUID.chomp)
+      {%- comment %}Whitespace control!{% endcomment -%}
+      Hello!
+    LIQUID
+  end
 end