Rewrite messages and issue description for TooManyFunctions rule - #552 #560
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
schalkms
approved these changes
Nov 18, 2017
vanniktech
approved these changes
Nov 18, 2017
Mauin
approved these changes
Nov 18, 2017
| "large classes and can quickly become God classes. " + | ||
| "Consider extracting methods to (new) classes better matching their responsibility.") | ||
| "Too many functions inside a/an file/class/object/interface always indicate a violation of " | ||
| + "the single responsibility principle. Maybe your file/class/object/interface wants to manage to many " + |
| "Consider extracting methods to (new) classes better matching their responsibility.") | ||
| "Too many functions inside a/an file/class/object/interface always indicate a violation of " | ||
| + "the single responsibility principle. Maybe your file/class/object/interface wants to manage to many " + | ||
| "things at once. Try to refactor out functionality which belong clearly together.") |
There was a problem hiding this comment.
I'd change the last sentence to "Extract functionality which clearly belongs together."
| @@ -56,20 +57,25 @@ class TooManyFunctions(config: Config = Config.empty) : Rule(config) { | |||
| report(ThresholdedCodeSmell(issue, | |||
| Entity.from(klass), | |||
| Metric("SIZE", amount, thresholdInInterfaces), | |||
| message = "")) // TODO: add class message | |||
| "Interface '${klass.name}' with '$amount' functions detected. " + | |||
There was a problem hiding this comment.
Totally love these messages and the descriptive issue description! 👍
|
I included your suggestions, thanks for the reviews! |
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.
Please also look at the other linked commit inside #552. I accidentally pushed the changes to master.
This PR adds messages for different TooManyFunctions findings and repairs the build.
Edit: I don't want to rewrite master history as someone may depend on the newest commit. Reverting the last commit can still be done if the changes are not good enought.