Add command-line switch -S/--display-style-guide

[marxarelli]

When enabled style guide URLs are added to offence messages. Setting
DisplayStyleGuide to true in the config has the same effect.

[coveralls]

Coverage decreased (-0.2%) to 99.44% when pulling 81f8e3344a8a57f9da66181de55d7bd9761acbc7 on marxarelli:feature/style-guide-url-in-output into 76e8f88 on bbatsov:master.

[coveralls]

Coverage decreased (-0.2%) to 99.44% when pulling 81f8e3344a8a57f9da66181de55d7bd9761acbc7 on marxarelli:feature/style-guide-url-in-output into 76e8f88 on bbatsov:master.

[coveralls]

Coverage increased (+0.0%) to 99.65% when pulling 81f8e3344a8a57f9da66181de55d7bd9761acbc7 on marxarelli:feature/style-guide-url-in-output into 76e8f88 on bbatsov:master.

[bbatsov]

Isn't this an overkill? After all the style guide rule is part of a cop's description and can easily been retrieved from there.

Any opinions?

[hashar]

We are running rubocop via Jenkins whenever someone propose a pull request. We sometime have new developers slightly confused by the information message and the extended description on the web page is really helpful.

[bquorning]

I’m not in favor of changing the message variable – I would prefer something like this:

def annotate_message(message)
  if display_cop_names?
    "#{name}: #{message}"
  elsif display_style_guide?
    "#{message} (#{style_guide_url})"
  else
    message
  end
end

[bbatsov]

This is not exactly the same - both flags can be enabled together.

[marxarelli]

@bquorning I'm not sure exactly what you mean by 'change' but my implementation doesn't mutate the message argument, if that's your concern.

[bquorning]

I think the word I was looking for was “shadowing” – that the returned message can be either the original method argument (if both conditionals are false) or a local variable of the same name.

It’s not that much of a problem, and as @bbatsov pointed out, my code example won’t work.

[bbatsov]

You forgot to update the changelog.

[bbatsov]

👍