Create a new cop group, MagicComments

[rrosenblum]

These cops always felt a bit weird being classified as Style cops. I think that this creates a good classification for grouping these cops.

This PR creates a new MagicComments group. It also moves Style/Encoding to MagicComments/Encoding and Style/FrozenStringLiteralComment to MagicComments/FrozenStringLiteral.

My vision for the future of this is to add a cop for warn_indent. Possibly add support for a warn_past_scope cop. Standardize the comment checks across all of these cops. Create a common configuration that determines whether the comments should all be on one line or all on separate lines. Create a configuration to set the order of how the comments should appear.

[Drenmi]

Thinking if this could be generalized to also include the cops for documentation comments?

[rrosenblum]

@Drenmi can you clarify that a little bit. It sounds like you are suggesting to create a Comment or Comments cop group that will contain the magic comments cops, Style/DocumentationMethod, Style/Documentation, Style/BlockComments, Style/InlineComment, Style/AsciiComments, Style/CommentIndentation, and Style/CommentAnnotation.

[bbatsov]

My vision for the future of this is to add a cop for warn_indent. Possibly add support for a warn_past_scope cop. Standardize the comment checks across all of these cops. Create a common configuration that determines whether the comments should all be on one line or all on separate lines. Create a configuration to set the order of how the comments should appear.

Sounds great to me.

[deivid-rodriguez]

Not sure how to explain it, but this new group feels a bit off to me. I don't feel it fits into the Perfomance, Style, Metrics division....

[Drenmi]

can you clarify that a little bit. It sounds like you are suggesting to create a Comment or Comments cop group [...]

Actually my train of thought has not reached any station yet. I think I started in the same place as you, with: "this isn't really about coding style, is it?" 😅

[rrosenblum]

I don't feel it fits into the Perfomance, Style, Metrics division....

Understandable. The same can be said about Bundler and Rails. MagicComments seemed like the best descriptor of this new group.

This conversation has caused me to think about the relationship that we have between cops and groups for all of the cops. Has anyone ever considered adding sub-categories to our groups? For example, what if we had Style/Alignment and this group contained what is currently AlignArray, AlignHash, AlignParameters, ElseAlignment, and RescueEnsureAlignment.

[backus]

Has anyone ever considered adding sub-categories to our groups? For example, what if we had Style/Alignment and this group contained what is currently AlignArray, AlignHash, AlignParameters, ElseAlignment, and RescueEnsureAlignment.

Yeah I was really interested in this because it would make it way easier for 3rd party cops. See rubocop/rubocop-rspec#232

[bbatsov]

Has anyone ever considered adding sub-categories to our groups? For example, what if we had Style/Alignment and this group contained what is currently AlignArray, AlignHash, AlignParameters, ElseAlignment, and RescueEnsureAlignment.

I don't recall us ever discussing something like this. Might be makes to some extent. Or we can assume that Style is a super broad category... I don't know. :-)

[bbatsov]

Closing due to lack of progress here.

[rrosenblum]

Closing due to lack of progress here.

I felt like there wasn't much that came out of the conversation on this. Is this something that we would want to work towards or should this be considered completely dead? If it is something that we would like to move towards, what kind of changes would you like to see?

[bbatsov]

I'm open to the idea of breaking down the Style namespace, but I'm not sure I want a separate namespace for magic comments. I'd love to see those 2 cops you mentioned in the PR, though.