improve rubocop-todo

[tamird]

Couple of simple ideas for rubocop-todo.

• When generating, it'd be nice to have a comment next to each cop listing the number of offences (exactly like --format offences gives).
• When generating, it'd be cool to list which cops support autocorrect, again, possibly in a comment.

cc @jonas054

[jonas054]

I think both are good ideas. I'll try to implement them.

[yujinakayama]

I think the comments are prone to be out of sync with actual project status and latest RuboCop autocorrect support.

[tamird]

@yujinakayama true, but every new release of rubocop requires me to run rubocop --auto-gen-config again anyway :p

[yujinakayama]

Then, I think it would be better if the following are also in the comments:

• When the rubocop-todo.yml was generated
• What version of RuboCop

[tamird]

sounds good to me.

[jonas054]

I've made changes to produce the comments we've discussed, and also comments about configuration parameters, which I think could be helpful. Sometimes a parameter can be changed and there's no need to disable the cop entirely. I want to make that clear to the user.

Something like this:

# This configuration was generated by `rubocop --auto-gen-config`
# on 2013-12-31 15:20:00 +0100 using RuboCop version 0.16.0.
# The point is for the user to remove these configuration records
# one by one as the offences are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

# Offence count: 1.
# Configuration parameters: EnforcedStyle, SupportedStyles.
AccessModifierIndentation:
  Enabled: false

# Offence count: 6.
CyclomaticComplexity:
  Max: 15

# Offence count: 11.
Documentation:
  Enabled: false

# Offence count: 29.
# Configuration parameters: AllowedVariables.
GlobalVars:
  Enabled: false

# Offence count: 20.
# Configuration parameters: CountComments.
MethodLength:
  Max: 30

# Offence count: 1.
# Cop supports --auto-correct.
TrailingWhitespace:
  Enabled: false

@tamird @yujinakayama What do yo think?

[tamird]

Oh that's awesome. Could we make it print acceptable values for the configuration parameters, too? Maybe not necessary if it's an integer, but great for EnforcedStyle for instance.

[jonas054]

Um, I think we have to draw the line somewhere. 😄 The parameters and their descriptions are available in config/default.yml. By the way, EnforcedStyle is generated into rubocop-todo.yml when changing its value removes the offences.

[tamird]

Okay, sounds good. I had dealt with EnforcedStyle in HashSyntax before that setting was generated 😑

[bbatsov]

@jonas054 I don't think that a line like # Offence count: 20. should end with a full stop. Other than that - the new comments look great.

[jonas054]

Ah, I just sent a pull request exactly the same time as your comment. I'll remove the . and send again.