Add parameters count to offense message for Metrics/ParameterLists cop
#4055
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pocke
force-pushed
the
metrics-output
branch
from
228e13c to
ca494f3
Compare
Most Metrics cops display `[%d/%d]`.
However, `Metrics/ParameterLists` and `Metrics/BlockNesting` don't display this.
For example:
```sh
$ rubocop --only Metrics -D
Inspecting 1 file
C
Offenses:
test.rb:1:1: C: Metrics/MethodLength: Method has too many lines. [12/10]
def foo(x, y, z, a, b, c, d, e) ...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
test.rb:1:8: C: Metrics/ParameterLists: Avoid parameter lists longer than 5 parameters.
def foo(x, y, z, a, b, c, d, e)
^^^^^^^^^^^^^^^^^^^^^^^^
test.rb:5:9: C: Metrics/BlockNesting: Avoid more than 3 levels of block nesting.
if cond4 ...
^^^^^^^^
1 file inspected, 3 offenses detected
```
I think those cops should display count/max.
However, `Metrics/BlockNesting` cop doesn't have the count value.
So, this change make to display the count only `Metrics/ParameterLists` cop.
Guess we should add it then. |
pocke
added a commit
to pocke/gry
that referenced
this pull request
Apr 9, 2017
pocke
added a commit
to pocke/gry
that referenced
this pull request
Apr 9, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most Metrics cops display
[%d/%d].However,
Metrics/ParameterListsandMetrics/BlockNestingdon't display this.For example:
$ rubocop --only Metrics -D Inspecting 1 file C Offenses: test.rb:1:1: C: Metrics/MethodLength: Method has too many lines. [12/10] def foo(x, y, z, a, b, c, d, e) ... ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ test.rb:1:8: C: Metrics/ParameterLists: Avoid parameter lists longer than 5 parameters. def foo(x, y, z, a, b, c, d, e) ^^^^^^^^^^^^^^^^^^^^^^^^ test.rb:5:9: C: Metrics/BlockNesting: Avoid more than 3 levels of block nesting. if cond4 ... ^^^^^^^^ 1 file inspected, 3 offenses detectedI think those cops should display count/max.
However,
Metrics/BlockNestingcop doesn't have the count value.So, this change make to display the count only
Metrics/ParameterListscop.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).and description in grammatically correct, complete sentences.
rake generate_cops_documentation(required only when you've added a new cop or changed the configuration/documentation of an existing cop).