Linter Rule: Detect malformed herb:disable comments

Rule: herb-disable-comment-malformed

Description

Detects malformed <%# herb:disable ... %> comments that have syntax errors like trailing commas, leading commas, consecutive commas, or missing spaces after herb:disable.

Rationale

Malformed <%# herb:disable ... %> comments can fail to parse correctly, leading to unexpected behavior where rules aren't actually disabled. This rule catches common syntax errors to ensure your disable comments work as intended.

Examples

✅ Good

<DIV>test</DIV> <%# herb:disable html-tag-name-lowercase %>

<DIV class='value'>test</DIV> <%# herb:disable html-tag-name-lowercase, html-attribute-double-quotes %>

<DIV class='value'>test</DIV> <%# herb:disable html-tag-name-lowercase , html-attribute-double-quotes %>

<DIV>test</DIV> <%# herb:disable all %>

🚫 Bad

<div>test</div> <%# herb:disable html-tag-name-lowercase, %>
`herb:disable` comment has a trailing comma. Remove the trailing comma. (herb-disable-comment-malformed)

<div>test</div> <%# herb:disable , html-tag-name-lowercase %>
`herb:disable` comment starts with a comma. Remove the leading comma. (herb-disable-comment-malformed)

<div>test</div> <%# herb:disable html-tag-name-lowercase,, html-attribute-double-quotes %>
`herb:disable` comment has consecutive commas. Remove extra commas. (herb-disable-comment-malformed)

<div>test</div> <%# herb:disable html-tag-name-lowercase,, %>
`herb:disable` comment has a trailing comma. Remove the trailing comma. (herb-disable-comment-malformed)

<DIV>test</DIV> <%# herb:disableall %>
`herb:disable` comment is missing a space after `herb:disable`. Add a space before the rule names. (herb-disable-comment-malformed)

<DIV>test</DIV> <%# herb:disablehtml-tag-name-lowercase %>
`herb:disable` comment is missing a space after `herb:disable`. Add a space before the rule names. (herb-disable-comment-malformed)

References

-