--show-cops CLI option

[dirkbolte]

When working with rubocop the last days I had issues to isolate cop names for either specifying them with --only or when adding a rubocop:disable comment.
For making this easier I thought about an option to list all available cops. The output is not pretty but it's a start.

[bbatsov]

I guess it would be nice if cops were displayed in categories - style, lint, rails.

[jonas054]

@dirkbolte Did you know that --debug shows the cop names together with the offence reports? Would that have solved your problem, or do you think --show-cops is better?

[yujinakayama]

👍 for this feature.

I've been thinking something like this too, since there's no list of available cops currently. Most users notice existence of each cop only when an offence is reported for their code for the first time.

[bbatsov]

This feature reminded me that it wouldn't be bad if all cops had some description we can show alongside their names.

[dirkbolte]

@jonas054 I never tried --debug as I considered this for rubocop debug purposes only. Actually the cop output of --debug was something I intended to suggest as a next pull request.
The intention of this CLI option was to give a short overview of what is possible because otherwise, it is pretty hard to find the actual cops. So what about I extend the output to the following:

• Add categories in display
• Add descriptions
• Show current config of each cop (enabled/disabled/settings)

[bbatsov]

The last bit will not be possible, since the enabled cops are calculated on a directory bases - unless we assume that with option we'll display the settings for the current directory (which is a reasonable suggestion).

As for the descriptions - I'd suggest you take them from default config file and add a DESCRIPTION constant to each method. Overall - I like your suggestions and probably a lot of people will find such functionality useful.

[jonas054]

@dirkbolte Sounds good! I have something that's been on my mind for a while. We have, or will have, these pieces of information related to each cop:

1. The message from the cop. Implemented as a constant MSG or sometimes a method error_message.
2. The description of the class in a comment. Used for generating documentation.
3. The comment in the configuration files describing the cop.
4. The DESCRIPTION constant that @bbatsov just mentioned.

Can we unify these and avoid duplication?

[dirkbolte]

My first approach would be to use a DESCRIPTION constant as suggested, extract the first line as a short message for the display (to have a similar behavior as Yard). If this constant isn't set, no description would be printed (do we don't have to adjust all cops at once).
I hope this matches your idea and we have a common base by this.
Next to that I would add the active config if rubocop would run in this directory (and mark this in the output accordingly).
I will upload a possible implementation for this in the next days.

[dirkbolte]

The last commit should contain all the features we talked about in this thread, although the code still looks a little ugly.

[jonas054]

Why is this part commented out?

[dirkbolte]

Will fix that. Forgot to re-enable it.

Am 04.08.2013 um 21:53 schrieb Jonas Arvidsson [email protected]:

In spec/rubocop/cli_spec.rb:

•    @stdout = $stdout.string
  

•  end
  

•  it 'prints all available cops and their description' do
  

•    subject
  

•    cops.each do |cop|
  

•     expect(@stdout).to include cop.cop_name
  

•     expect(@stdout).to include cop.short_description
  

•   end
  

•  end
  

•  it 'prints all categories' do
  

•    subject
  

•    cops.categories.each { |cat| expect(@stdout).to include(cat) }
  

•  end
  

  +# it 'prints all cops in their right category' do
  Why is this part commented out?

—
Reply to this email directly or view it on GitHub.

[dirkbolte]

I added the changes and moved all comments in the default configs to 'Description'. Branch is rebased to upstream.

I also added a spec to ensure that all future cops have a description.

An issue with the implementation is that descriptions do not wrap cleanly at 80 characters when calling --show-cops.

[bbatsov]

Seems to me you used some code that's available only in Ruby 2.0 since the build is failing for all other Rubies.

[bbatsov]

Move this entry to the latest version of RuboCop, since 0.11.0 was already released.

[bbatsov]

Looks good now. I've added some minor style remarks as inline comments in the code - address them, squash the commits into one and we're good to merge this.

[dirkbolte]

Will do. Thanks for the feedback.

Am 12.08.2013 um 10:33 schrieb Bozhidar Batsov [email protected]:

Looks good now. I've added some minor style remarks as inline comments in the code - address them, squash the commits into one and we're good to merge this.

—
Reply to this email directly or view it on GitHub.

[bbatsov]

The code looks OK now. Just don't forget to squash the commits together into one.

[dirkbolte]

Hope that squash is ok. Thanks for the patience.

[bbatsov]

You're welcome :-)