Skip to content

Complete RuboCop style guide links #454

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

Open
oiahoon wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −5
Open

Complete RuboCop style guide links #454

Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions STYLEGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ remove_member(user, skip_membership_check: true)

* Use `snake_case` for methods and variables.
<a name="snake-case-methods-vars"></a><sup>[[link](#snake-case-methods-vars)]</sup>
* <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingsnakecase">RuboCop rule: Naming/SnakeCase</a>
* <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingmethodname">RuboCop rule: Naming/MethodName</a>
* <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingvariablename">RuboCop rule: Naming/VariableName</a>

* Use `CamelCase` for classes and modules. (Keep acronyms like HTTP,
Expand All @@ -493,7 +493,7 @@ remove_member(user, skip_membership_check: true)
* The names of predicate methods (methods that return a boolean value)
should end in a question mark. (i.e. `Array#empty?`).
<a name="bool-methods-qmark"></a><sup>[[link](#bool-methods-qmark)]</sup>
* <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingpredicatename">RuboCop rule: Naming/PredicateName</a>
* <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingpredicateprefix">RuboCop rule: Naming/PredicatePrefix</a>

* The names of potentially "dangerous" methods (i.e. methods that modify `self` or the
arguments, `exit!`, etc.) should end with an exclamation mark. Bang methods
Expand Down Expand Up @@ -718,7 +718,7 @@ end
* Favor modifier `if/unless` usage when you have a single-line
body.
<a name="favor-modifier-if-unless"></a><sup>[[link](#favor-modifier-if-unless)]</sup>
* <a href="https://docs.rubocop.org/rubocop/cops_style.html#stylemultilineternaryoperator">RuboCop rule: Style/MultilineTernaryOperator</a>
* <a href="https://docs.rubocop.org/rubocop/cops_style.html#styleifunlessmodifier">RuboCop rule: Style/IfUnlessModifier</a>

``` ruby
# bad
Expand Down Expand Up @@ -788,7 +788,7 @@ end
trivial. However, do use the ternary operator(`?:`) over `if/then/else/end` constructs
for single line conditionals.
<a name="trivial-ternary"></a><sup>[[link](#trivial-ternary)]</sup>
* <a href="https://docs.rubocop.org/rubocop/cops_style.html#stylemultilineternaryoperator">RuboCop rule: Style/MultilineTernaryOperator</a>
* <a href="https://docs.rubocop.org/rubocop/cops_style.html#styleonelineconditional">RuboCop rule: Style/OneLineConditional</a>

``` ruby
# bad
Expand Down Expand Up @@ -878,7 +878,7 @@ end

* Use spaces around the `=` operator when assigning default values to method parameters:
<a name="spaces-around-equals"></a><sup>[[link](#spaces-around-equals)]</sup>
* <a href="https://docs.rubocop.org/rubocop/cops_style.html#stylespacearoundequalsinparameterdefault">RuboCop rule: Style/SpaceAroundEqualsInParameterDefault</a>
* <a href="https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacearoundequalsinparameterdefault">RuboCop rule: Layout/SpaceAroundEqualsInParameterDefault</a>

``` ruby
# bad
Expand Down
12 changes: 12 additions & 0 deletions config/default.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ Layout/SpaceAfterMethodName:

Layout/SpaceAfterNot:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-spaces-bang

Layout/SpaceAfterSemicolon:
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-operators
Expand All @@ -311,6 +312,7 @@ Layout/SpaceAroundOperators:

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

Layout/SpaceBeforeBrackets:
Enabled: false
Expand Down Expand Up @@ -346,6 +348,7 @@ Layout/SpaceInsideHashLiteralBraces:

Layout/SpaceInsideParens:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-spaces-braces

Layout/SpaceInsidePercentLiteralDelimiters:
Enabled: false
Expand All @@ -355,6 +358,7 @@ Layout/SpaceInsideRangeLiteral:

Layout/SpaceInsideReferenceBrackets:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-spaces-braces

Layout/SpaceInsideStringInterpolation:
Enabled: false
Expand Down Expand Up @@ -825,12 +829,14 @@ Naming/MemoizedInstanceVariableName:

Naming/MethodName:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#snake-case-methods-vars

Naming/MethodParameterName:
Enabled: false

Naming/PredicatePrefix:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#bool-methods-qmark

Naming/RescuedExceptionsVariableName:
Enabled: false
Expand Down Expand Up @@ -1269,6 +1275,7 @@ Style/IfInsideElse:

Style/IfUnlessModifier:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#favor-modifier-if-unless

Style/IfUnlessModifierOfIfUnless:
Enabled: false
Expand Down Expand Up @@ -1369,6 +1376,7 @@ Style/MultilineMethodSignature:

Style/MultilineTernaryOperator:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-multiline-ternary

Style/MultilineWhenThen:
Enabled: false
Expand Down Expand Up @@ -1442,6 +1450,7 @@ Style/ObjectThen:

Style/OneLineConditional:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#trivial-ternary

Style/OpenStructUse:
Enabled: false
Expand All @@ -1454,6 +1463,7 @@ Style/OptionalArguments:

Style/OptionalBooleanParameter:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#keyword-arguments

Style/OrAssignment:
Enabled: true
Expand All @@ -1466,6 +1476,7 @@ Style/ParallelAssignment:

Style/ParenthesesAroundCondition:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-parens-if-unless-while

Style/PercentLiteralDelimiters:
Enabled: false
Expand Down Expand Up @@ -1628,6 +1639,7 @@ Style/StringChars:

Style/StringConcatenation:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#string-interpolation

Style/StringHashKeys:
Enabled: false
Expand Down
Loading