Preserve Comment

Preserve the inner contents of HTML comments. When this rule is enabled (i.e: true) it will ignore formatting HTML comments and override commentIndent and commentNewline rule definitions.

Rule Options

The preserveComment rule is disabled (false) by default. The recommended setting to use is false unless you have extensive context contained within comments.

Example

In the below example we have enabled comment preservation. Both the commentIndent and commentNewline rules will no longer have effect on output as the the preserveComment rule takes precedence.

{
  "language": "html",
  "markup": {
    "commentNewline": false, // This setting will be ignored
    "commentIndent": true, // This setting will be ignored
    "preserveComment": true // When enabled, this rule takes precedence
  }
}

🙌

false

This preserveComment rule is set to false by default. In the example below, the Liquid comment will be formatted.

<main>
  <!--

  This comment will be indented and a newline
  will be inserted above. We have set both the
  "commentNewline" and "commentIndent" rules
  to true.

        These lines however will be aligned to
        the starting point of the comment blocks.

                  In the next example where we set
                  this rule the true, you will notice
                  how preservation is respected.

  -->
  <aside>
    Hello World!
  </aside>
  <!--
                  Same as above, the comment will be formatted!
                  -->
</main>

<main>
  <!-- This comment will be indented and a newline    will be inserted above. We have set both the    "commentNewline" and "commentIndent" rules    to true.        These lines however will be aligned to    the starting point of the comment blocks.        In the next example where we set    this rule the true, you will notice    how preservation is respected. -->
  <aside>
    Hello World!
  </aside>
<!--
  Same as above, the comment will be formatted!
-->
</main>

🧐

true

When the preserveComment rule is enabled (true) then the contents of block comments will be excluded from formatting. As aforementioned, when set to true the rule will override commentNewline and commentIndent settings.

<ul>
  <li>Hello</li>

    <!--

  This comment will be preserved
  Even though we have set both the
  "commentNewline" and "commentIndent"
  rules to true.

        The comment tag will will align
        itself to the li node above
        but the content will not be touched.

              This is nice when you need to provide detailed
              descriptions or code examples within comments.

    -->

  <li>World</li>
<!--
              Same as above, the comment is preserved!

              -->
</ul>

<ul>
  <li>Hello</li>

  <!--      This comment will be preserved    Even though we have set both the    "commentNewline" and "commentIndent"    rules to true.            The comment tag will will align          itself to the li node above          but the content will not be touched.                  This is nice when you need to provide detailed                descriptions or code examples within comments.        -->  

  <li>World</li>
<!--
              Same as above, the comment is preserved!

              -->
</ul>