Add Exclude items to the DisabledConfigFormatter output

[bmorrall]

I was testing some legacy code by using --auto-gen-config, and found it frustrating that trivial Cops had been disabled due to trival issues in one or two files.

I didn't want to disable Whitespace Formatting, or other Style rules in any new code; so I thought I'd play around with the generator to Exclude relative file paths.

An example of what I managed to make it output, is as follows:

# Offense count: 1
# Cop supports --auto-correct.
Style/Tab:
  Exclude:
    - 'example2.rb'

This way, its easier to globally disable Cops in my .rubocop.yml, and have a checklist of files to fix in my .rubocop_todos.yml, instead of globally disabling rules the rest of my code abides by.

What do you think?

[philoserf]

👍 👌 👏

[bbatsov]

I think this. I think something similar was proposed in the past. I'm just worried about cases where there may be hundreds of files in the exclude list, but there's no denying you get a better overview of what remains to be fixed in your code.

@jonas054 What do you think?

[bmorrall]

I could always add a threshold for the maximum amount of items to display, with a fallback to Enabled: false if the limit is exceeded

[philoserf]

More 👍 👏

[bbatsov]

I could always add a threshold for the maximum amount of items to display, with a fallback to Enabled: false if the limit is exceeded

Sounds reasonable.

[bmorrall]

I chose a limit of 15, for no reason; other than I think 10 is too low, and 20 is too high. Any thoughts?

[jonas054]

👍 Looks fine to me. Only Enabled: false can be replaced by Exclude:, and any other configuration generated by --auto-gen-config remains as today. That's good. For reference, this subject has been discussed in #988, #1531, and #1709.

[bbatsov]

Add a changelog entry and we're good to merge.

[bmorrall]

Done, Glad I could help :)

[bbatsov]

Can you just squash all 3 commits into one?

[bmorrall]

@bbatsov Done and done!

[bbatsov]

Thanks!

[TimMoore]

This is the best... thanks all!