Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rubocop_todo references cop configuration but could be more useful #2322

Closed
maxjacobson opened this issue Oct 14, 2015 · 4 comments
Closed

Comments

@maxjacobson
Copy link
Contributor

An example excerpt from my .rubocop_todo.yml

# Offense count: 151                                                                
# Cop supports --auto-correct.                                                      
# Configuration parameters: EnforcedStyle, SupportedStyles.                         
Style/MultilineOperationIndentation:                                                
  Enabled: false                                                                    

The "Configuration parameters" line could be more useful, I think. I don't really care that it has a SupportedStyles configuration. However, I'm very interested that it has an EnforcedStyle parameter, but I need to hunt through the rubocop source code to determine what the valid options are to choose from. What do you think about including those options here?

@jonas054
Copy link
Collaborator

Sounds like a good idea. We can't go by name because these parameters are not always called SupportedStyles, but if we list the elements for all parameters whose type is Array, I think it will be an improvement.

# Offense count: 151
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: aligned, indented
Style/MultilineOperationIndentation:
  Enabled: false

@maxjacobson
Copy link
Contributor Author

That sounds great to me

@alexdowad
Copy link
Contributor

Just opened a PR which implements @jonas054's suggestion.

@maxjacobson
Copy link
Contributor Author

🙏 sweet!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants