lib/liquid/tags/comment.rb
# frozen_string_literal: true module Liquid # @liquid_public_docs # @liquid_type tag # @liquid_category syntax # @liquid_name comment # @liquid_summary # Prevents an expression from being rendered or output. # @liquid_description # Any text inside `comment` tags won't be output, and any Liquid code will be parsed, but not executed. # @liquid_syntax # {% comment %} # content # {% endcomment %} # @liquid_syntax_keyword content The content of the comment. class Comment < Block def render_to_output_buffer(_context, output) output end def unknown_tag(_tag, _markup, _tokens) end def blank? true end private def parse_body(body, tokenizer) if parse_context.depth >= MAX_DEPTH raise StackLevelError, "Nesting too deep" end parse_context.depth += 1 comment_tag_depth = 1 begin # Consume tokens without creating child nodes. # The children tag doesn't require to be a valid Liquid except the comment and raw tag. # The child comment and raw tag must be closed. while (token = tokenizer.send(:shift)) tag_name = if tokenizer.for_liquid_tag next if token.empty? || token.match?(BlockBody::WhitespaceOrNothing) tag_name_match = BlockBody::LiquidTagToken.match(token) next if tag_name_match.nil? tag_name_match[1] else token =~ BlockBody::FullToken Regexp.last_match(2) end case tag_name when "raw" parse_raw_tag_body(tokenizer) when "comment" comment_tag_depth += 1 when "endcomment" comment_tag_depth -= 1 end if comment_tag_depth.zero? parse_context.trim_whitespace = (token[-3] == WhitespaceControl) unless tokenizer.for_liquid_tag return false end end raise_tag_never_closed(block_name) ensure parse_context.depth -= 1 end false end def parse_raw_tag_body(tokenizer) while (token = tokenizer.send(:shift)) return if token =~ BlockBody::FullTokenPossiblyInvalid && "endraw" == Regexp.last_match(2) end raise_tag_never_closed("raw") end end Template.register_tag('comment', Comment) end