Comment Indent
The commentIndent rule applies single level indentation to the containing content of Liquid block type comments. This is a Liquid specific formatting rule which defaults to using false when no option is defined. The Recommended setting to use is true.
Liquid line type comments
{% # example %}are currently not supported by this rule. Only block type Liquid tokens will be handled.
Rule Override
When the preserveComment (liquid) rule is enabled (i.e: true) it will take precedence and override commentIndent rule.
true
Below is an example of how this rule works if it’s enabled (true). Notice how after formatting when this rule is enabled that the inner contents of the Liquid comment tag regions are indented.
- default
- recommended
- warrington
- strict
- prettier
{% comment %}
Example
The contents of this comment will have indentation applied
{% endcomment %}
{% comment %}
Example
The contents of this comment will have indentation applied
{% endcomment %}false
The commentIndent rule is disabled by default, so Liquid comments do not apply indentation. Liquid block comment contents will have indentation removed in the sample when formatting.
- default
- recommended
- warrington
- strict
- prettier
{% comment %}
Example
The contents of this comment will have indentation stripped.
{% endcomment %}
{% comment %}
Example
The contents of this comment will have indentation stripped.
{% endcomment %}