The {% comment %} tag parses its body
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 11.9k
- Forks
- 1.5k
- Avg merge
- 17h 55m
- Merged PRs (30d)
- 3
Description
Problem
It would be reasonable to expect any text between {% comment %} and {% endcomment %} to be completely ignored.
However, that is not the case:
❯ irb
irb(main):001:0> require 'liquid'
=> true
irb(main):002:0> Liquid::VERSION
=> "4.0.0"
irb(main):003:0> Liquid::Template.parse("{% comment %}{% if 'foo' %}{% endcomment %}")
Liquid::SyntaxError: Liquid syntax error: Unknown tag 'endcomment'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block.rb:38:in `unknown_tag'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/tags/if.rb:36:in `unknown_tag'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block.rb:68:in `block in parse_body'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block_body.rb:33:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block.rb:58:in `parse_body'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/tags/if.rb:24:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/tag.rb:10:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block_body.rb:27:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block.rb:58:in `parse_body'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block.rb:12:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/tag.rb:10:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/block_body.rb:27:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/document.rb:10:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/document.rb:5:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/template.rb:132:in `parse'
from /Users/david/.gem/ruby/2.3.3/bundler/gems/liquid-c582b86f16b6/lib/liquid/template.rb:116:in `parse'
Cause
I believe this is because Liquid::Comment inherits from Liquid::Block
which parses its body
My initial thought was that this should have been caught by Liquid::Comment#unknown_tag
but the exception is being raised from within Liquid::If#unknown_tag
which makes sense seen as {% if %} owns its own body.
Fix?
A potential solution might be to override Liquid::Block#parse
in Liquid::Comment seen as #render always returns an empty string.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with lib/liquid/tags/comment.rb and lib/liquid/block.rb, then reproduce the reported Liquid::Template.parse example. Check how the comment tag parses its body and ensure content between comment markers is ignored, including nested tags such as if. Done means the example parses without the unknown endcomment error and comment rendering remains empty.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100