Inlined rubocop:disable comments are formatted to a new line

[coisnepe]

Metadata

• Ruby version: 2.7.2
• @prettier/plugin-ruby version: 1.5.2

Somewhat linked to #706 in that it's inline comments that are taken to a newline, but it's not restricted to specific keywords, i.e. raise. Inline rubocop comments are there for a reason (admittedly not always good ones), but I'm dealing with a massive codebase with over 400 inlined rubocop comments so ideally I'd like to find a way to not manually convert the inlined comments to disable\n....\nenable !

Input

  # rubocop:todo Metrics/MethodLength
  def to_props( # rubocop:todo Metrics/ParameterLists
    profile:,

Current output

  # rubocop:todo Metrics/MethodLength
  def to_props(
    # rubocop:todo Metrics/ParameterLists
    profile:,

Expected output

  # rubocop:todo Metrics/MethodLength
  def to_props( # rubocop:todo Metrics/ParameterLists
    profile:,

[coisnepe]

I tried digging into the code, in places such as this, but to no avail…

plugin-ruby/src/ruby/parser.rb

Line 2029 in 30b835a

!comment[:value].include?('prettier-ignore')

[coisnepe]

There's probably something I'm missing, but changing this line

plugin-ruby/test/js/ruby/comments.test.js

Line 155 in 30b835a

expect("foo # this is an inline comment").toMatchFormat());

to:

test('basic', () => expect('foo # rubocop:disable Metrics/MethodLength').toMatchFormat())

works…

Any help or insight would be greatly appreciated!

[kddnewton]

Hi @coisnepe - have you checked out the CONTRIBUTING.md docs? That should help you get an understanding of where to start. You'll need to know which AST nodes def foo( # bar is parsing, and then see how comments are getting attached.

I don't have time at the moment to handle this issue but I'll get back around to it eventually. In the meantime please feel free to dig in!

[coisnepe]

Hi @kddeisz, thank you so much for taking the time to reply. I'll dig into this doc, which I had overlooked -sorry. Thanks for pointing it out.

In the meantime I just want to add the the issue isn't about def foo( # bar so much as it is about all inlined rubocop:disable comments.

I'm in the process of migrating all the inlined comments to disable/enable multilines, as I want to get going with the "prettier" migration.

Thanks again for your help and time, implementing code formatting in my company's codebase is going to be a huge leap forward!

We'll dig into the source code eventually to try and submit a Pull Request, if relevant.

[msakrejda]

@coisnepe I ran into the same thing trying to move formatting in our project from Rubocop to Prettier. Did you have any luck with fixing or investigating this? Thanks for looking into it!

[coisnepe]

Hey @uhoh-itsmaciek, I ended up running a regex against our code base to find the inlined rubocop disables to automatically replace them with the disable/enable pattern. It mostly worked, and in case it didn't I replaced them manually.

[msakrejda]

@coisnepe great, thanks for the info.

[kddnewton]

I've got a fix coming for this! It will be out in the next release.