Skip to content

config/default: Link some rules to their styleguide justifications #124

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 19, 2022
Merged

config/default: Link some rules to their styleguide justifications #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions config/default.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,10 @@ Layout/BlockAlignment:
Layout/BlockEndNewline:
Enabled: true

# TODO: Enable this since it's in the styleguide.
Layout/CaseIndentation:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#indent-when-as-start-of-case

Layout/ClassStructure:
Enabled: false
Expand Down Expand Up @@ -186,10 +188,12 @@ Layout/IndentationStyle:
Enabled: true
EnforcedStyle: spaces
IndentationWidth: 2
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#default-indentation

Layout/IndentationWidth:
Enabled: true
Width: 2
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#default-indentation

Layout/InitialIndentation:
Enabled: true
Expand Down Expand Up @@ -259,9 +263,11 @@ Layout/SingleLineBlockChain:

Layout/SpaceAfterColon:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-operators

Layout/SpaceAfterComma:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-operators

Layout/SpaceAfterMethodName:
Enabled: true
Expand All @@ -271,12 +277,14 @@ Layout/SpaceAfterNot:

Layout/SpaceAfterSemicolon:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-operators

Layout/SpaceAroundBlockParameters:
Enabled: true

Layout/SpaceAroundEqualsInParameterDefault:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-around-equals

Layout/SpaceAroundKeyword:
Enabled: false
Expand Down Expand Up @@ -311,6 +319,7 @@ Layout/SpaceInLambdaLiteral:
Layout/SpaceInsideArrayLiteralBrackets:
Enabled: true
EnforcedStyle: no_space
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-spaces-braces

Layout/SpaceInsideArrayPercentLiteral:
Enabled: true
Expand Down Expand Up @@ -341,6 +350,7 @@ Layout/TrailingEmptyLines:

Layout/TrailingWhitespace:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#trailing-whitespace

Lint/AmbiguousAssignment:
Enabled: false
Expand Down Expand Up @@ -678,8 +688,10 @@ Lint/UnreachableCode:
Lint/UnreachableLoop:
Enabled: false

# TODO: Enable this since it's in the styleguide.
Lint/UnusedBlockArgument:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-around-equals
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#underscore-unused-vars?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, yes it should! Feel free to submit a PR!


Lint/UnusedMethodArgument:
Enabled: false
Expand Down Expand Up @@ -976,8 +988,10 @@ Style/AccessorGrouping:
Style/Alias:
Enabled: false

# TODO: Enable this since it's in the styleguide.
Style/AndOr:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-and-or-or

Style/ArgumentsForwarding:
Enabled: false
Expand Down Expand Up @@ -1077,6 +1091,7 @@ Style/DateTime:

Style/DefWithParentheses:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#method-parens-when-arguments

Style/Dir:
Enabled: false
Expand Down Expand Up @@ -1164,6 +1179,7 @@ Style/FloatDivision:

Style/For:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#avoid-for

Style/FormatString:
Enabled: false
Expand Down Expand Up @@ -1201,6 +1217,7 @@ Style/HashLikeCase:
Style/HashSyntax:
Enabled: true
EnforcedStyle: ruby19_no_mixed_keys
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#symbols-as-keys

Style/HashTransformKeys:
Enabled: false
Expand Down Expand Up @@ -1300,6 +1317,7 @@ Style/MultilineIfModifier:

Style/MultilineIfThen:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-then-for-multi-line-if-unless

Style/MultilineInPatternThen:
Enabled: false
Expand Down Expand Up @@ -1475,8 +1493,10 @@ Style/RedundantRegexpCharacterClass:
Style/RedundantRegexpEscape:
Enabled: false

# TODO: Enable this since it's in the styleguide.
Style/RedundantReturn:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#avoid-return

Style/RedundantSelf:
Enabled: false
Expand Down Expand Up @@ -1626,8 +1646,10 @@ Style/TrailingUnderscoreVariable:
Style/TrivialAccessors:
Enabled: false

# TODO: Enable this since it's in the styleguide.
Style/UnlessElse:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-else-with-unless

Style/UnlessLogicalOperators:
Enabled: false
Expand Down