Formatter: "Herb disable" comment to disable rules in-line

[crmne]

Hey Marco,

it would be great to use comments to disable specific rules inline. For example:

  <div
    data-markdown-target="source"
    data-clipboard-target="source"
    class="hidden"
    id="<%= dom_id(message) %>_source"
  ><%= render "messages/content", content: message.content %></div>

This gets rightfully formatted with the render tag in a new line, but doing so breaks the formatting of my app, which uses marked.js to render the message content from that div.

It would be great to be able to add a comment, similarly to rubocop, to disable the formatter for that specific line.

[marcoroth]

Thanks for bringing this up. There's an open pull request for disabling single lines of the linter (#531), but I don't quite see how we could be doing that with the formatter 🤔

For this specific case, if you can, you might want to consider using a <pre> tag instead of a <div>, since <div> are not whitespace-significant strictly speaking.

[crmne]

For this specific case, if you can, you might want to consider using a \<pre\> tag instead of a <div>, since <div> are not whitespace-significant strictly speaking.

Well, that solved it for me! Thank you!

[marcoroth]

Sweet, thanks for confirming!

RE: the bigger question to disable a single line: we have the functionality to only format part of a document (like selecting a part of the document and using Format Selection in VS Code).

Maybe we can look for a disabling formatter comment in the document, split the document into many parts based on that, and then partially format the parts that we can format. This could work, but I'm not sure if this is really desirable or produces actually useful output (like if you have missing tags because of that) 🤔

I'll keep thinking about this, but I don't think we can easily implement this, sadly.

[marcoroth]

This should be resolved with #531 and will be released with v0.8.0.

[marcoroth]

My bad, I just realized this is about the formatter. But with #747 we can exclude files for the formatter based on patterns.

[marcoroth]

v0.8.2 just shipped support for <%# herb:formatter ignore %> in #891.

I don't think we are easily able to support this in-line or just for a specific line in the near future, so I'm going to close this.