search

r7kamura / rubocop-slim

RuboCop plugin for Slim template.
MIT License
7 stars 1 forks source link

Issue when auto correcting a template that contains multiple lint errors #12

Open Nerian opened 1 year ago

Nerian commented 1 year ago

Hi,

I detected the following issue:

Given a template with:

= "#{ @hello }"
= "#{ @hello }"
= "#{ @hello }"

When I run rubocop -A I get

Inspecting 1 file
C

Offenses:

apps/mis/app/views/mis/documents/_documents_import.html.slim:1:6: C: [Corrected] Layout/SpaceInsideStringInterpolation: Space inside string interpolation detected.
= "#{ @hello }"
     ^
apps/mis/app/views/mis/documents/_documents_import.html.slim:1:13: C: Layout/SpaceInsideStringInterpolation: Space inside string interpolation detected.
= "#{ @hello }"
            ^
apps/mis/app/views/mis/documents/_documents_import.html.slim:2:6: C: [Corrected] Layout/SpaceInsideStringInterpolation: Space inside string interpolation detected.
= "#{ @hello }"
     ^
apps/mis/app/views/mis/documents/_documents_import.html.slim:2:13: C: Layout/SpaceInsideStringInterpolation: Space inside string interpolation detected.
= "#{ @hello }"
            ^
apps/mis/app/views/mis/documents/_documents_import.html.slim:3:6: C: [Corrected] Layout/SpaceInsideStringInterpolation: Space inside string interpolation detected.
= "#{ @hello }"
     ^

And the file is auto corrected like this:

= "#{ @hello }"
= "#{@hello}"
= "#{@hello}"

So auto correction works only partially when there are multiple issues in a given template.

r7kamura commented 1 year ago

Thanks for the report 👍 Since slimi is just a Slim parser and has nothing to do with RuboCop, I transferred this issue from slimi to rubocop-slim.

r7kamura commented 1 year ago

Perhaps this is not a problem with the implementation of individual plugins such as rubocop-slim or rubocop-erb, but with rubocop, so I think it should actually be recognized as a rubocop's template API issue.

In rubocop, there is a mechanism to repeat autocorrection for a single file until there are no more offenses. On the other hand, rubocop's template API has a mechanism to treat multiple Ruby codes embedded in one template file as multiple virtual files. I assume that these mechanisms do not work well together, resulting in this problem...

r7kamura commented 3 months ago

After investigating for a while, I found out that RuboCop generates multiple ProcessedSource from one template, autocorrects them independently, and writes the conversion result to the original template file multiple times. Individual conversions do not take other conversions into account. So, in the end, it appears that only the result of the autocorrect for the last ProcessedSlource processed is written to the original template file.