Formatter: Scaffold Templates

[cb341]

Input:

<%# frozen_string_literal: true %>
<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
  <%%= f.error_notification %>
  <%%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %>

  <div class="form-inputs">
  <%- attributes.each do |attribute| -%>
    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
  <%- end -%>
  </div>

  <div class="form-actions">
    <%%= f.button :submit %>
  </div>
<%% end %>

Output:

<%# frozen_string_literal: true %>

<%%= simple_form_for(@<%= singular_table_name %>

) do |f| %>

<%%= f.error_notification %>

<%%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %>

<div class="form-inputs">
  <%- attributes.each do |attribute| %>
    <%%= f.<%= attribute.reference? ? :association : :input %>
    :
    <%= attribute.name %>
    %>
  <%- end %>
</div>

<div class="form-actions"><%%= f.button :submit %></div>

<%% end %>

Expected:

<%# frozen_string_literal: true %>

<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
  <%%= f.error_notification %>
  <%%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %>

  <div class="form-inputs">
  <%- attributes.each do |attribute| -%>
    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
  <%- end -%>
  </div>

  <div class="form-actions">
    <%%= f.button :submit %>
  </div>
<%% end %>

Playground:

Playground Url

Additional context:

Scaffold templates are a bit of an edge case but I'd still expect them to be ignored by the formatter instead of being malformed.

[marcoroth]

Oh, thanks for reporting! That's very interesting and something I haven't really put too much thought into yet. I guess we cannot really reliably parse and format this with the current setup, since we have to better understand indentation-levels. Hmm 🤔

[marcoroth]

I opened #771 which skips over scaffold templates when formatting. I don't think we have a viable strategy right now to be able to properly parse and format these templates. These templates are also rare and probably don't gain much from being auto-formatted.

I don't want to say we are never going to support them, but it's definitely not a design goal of the parser and a priority. For now, I believe that #771 should be a good trade-off.

[cb341]

Very cool! Thanks a bunch @marcoroth 🙌
I don't mind having them be excluded from the formatting.
Most important thing is that they no longer get malformed.