1038 lines
25 KiB
YAML
1038 lines
25 KiB
YAML
require:
|
|
- rubocop-rspec
|
|
- ./rubocop/rubocop
|
|
|
|
inherit_from: .rubocop_todo.yml
|
|
|
|
AllCops:
|
|
TargetRubyVersion: 2.3
|
|
# Cop names are not d§splayed in offense messages by default. Change behavior
|
|
# by overriding DisplayCopNames, or by giving the -D/--display-cop-names
|
|
# option.
|
|
DisplayCopNames: true
|
|
# Style guide URLs are not displayed in offense messages by default. Change
|
|
# behavior by overriding DisplayStyleGuide, or by giving the
|
|
# -S/--display-style-guide option.
|
|
DisplayStyleGuide: false
|
|
# Exclude some GitLab files
|
|
Exclude:
|
|
- 'vendor/**/*'
|
|
- 'node_modules/**/*'
|
|
- 'db/*'
|
|
- 'db/fixtures/**/*'
|
|
- 'tmp/**/*'
|
|
- 'bin/**/*'
|
|
- 'generator_templates/**/*'
|
|
|
|
# Gems in consecutive lines should be alphabetically sorted
|
|
Bundler/OrderedGems:
|
|
Enabled: false
|
|
|
|
# Style #######################################################################
|
|
|
|
# Check indentation of private/protected visibility modifiers.
|
|
Style/AccessModifierIndentation:
|
|
Enabled: true
|
|
|
|
# Check the naming of accessor methods for get_/set_.
|
|
Style/AccessorMethodName:
|
|
Enabled: false
|
|
|
|
# Use alias_method instead of alias.
|
|
Style/Alias:
|
|
EnforcedStyle: prefer_alias_method
|
|
Enabled: true
|
|
|
|
# Align the elements of an array literal if they span more than one line.
|
|
Style/AlignArray:
|
|
Enabled: true
|
|
|
|
# Align the elements of a hash literal if they span more than one line.
|
|
Style/AlignHash:
|
|
Enabled: true
|
|
|
|
# Here we check if the parameters on a multi-line method call or
|
|
# definition are aligned.
|
|
Style/AlignParameters:
|
|
Enabled: false
|
|
|
|
# Whether `and` and `or` are banned only in conditionals (conditionals)
|
|
# or completely (always).
|
|
Style/AndOr:
|
|
Enabled: true
|
|
|
|
# Use `Array#join` instead of `Array#*`.
|
|
Style/ArrayJoin:
|
|
Enabled: true
|
|
|
|
# Use only ascii symbols in comments.
|
|
Style/AsciiComments:
|
|
Enabled: true
|
|
|
|
# Use only ascii symbols in identifiers.
|
|
Style/AsciiIdentifiers:
|
|
Enabled: true
|
|
|
|
# Checks for uses of Module#attr.
|
|
Style/Attr:
|
|
Enabled: true
|
|
|
|
# Avoid the use of BEGIN blocks.
|
|
Style/BeginBlock:
|
|
Enabled: true
|
|
|
|
# Do not use block comments.
|
|
Style/BlockComments:
|
|
Enabled: true
|
|
|
|
# Avoid using {...} for multi-line blocks (multiline chaining is # always
|
|
# ugly). Prefer {...} over do...end for single-line blocks.
|
|
Style/BlockDelimiters:
|
|
Enabled: true
|
|
|
|
# Put end statement of multiline block on its own line.
|
|
Style/BlockEndNewline:
|
|
Enabled: true
|
|
|
|
# This cop checks for braces around the last parameter in a method call
|
|
# if the last parameter is a hash.
|
|
Style/BracesAroundHashParameters:
|
|
Enabled: false
|
|
|
|
# This cop checks for uses of the case equality operator(===).
|
|
Style/CaseEquality:
|
|
Enabled: false
|
|
|
|
# Indentation of when in a case/when/[else/]end.
|
|
Style/CaseIndentation:
|
|
Enabled: true
|
|
|
|
# Checks for uses of character literals.
|
|
Style/CharacterLiteral:
|
|
Enabled: true
|
|
|
|
# Use CamelCase for classes and modules.'
|
|
Style/ClassAndModuleCamelCase:
|
|
Enabled: true
|
|
|
|
# Checks style of children classes and modules.
|
|
Style/ClassAndModuleChildren:
|
|
Enabled: false
|
|
|
|
# Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
|
|
Style/ClassCheck:
|
|
Enabled: true
|
|
|
|
# Use self when defining module/class methods.
|
|
Style/ClassMethods:
|
|
Enabled: true
|
|
|
|
# Avoid the use of class variables.
|
|
Style/ClassVars:
|
|
Enabled: true
|
|
|
|
# This cop checks for methods invoked via the :: operator instead
|
|
# of the . operator (like FileUtils::rmdir instead of FileUtils.rmdir).
|
|
Style/ColonMethodCall:
|
|
Enabled: true
|
|
|
|
# This cop checks that comment annotation keywords are written according
|
|
# to guidelines.
|
|
Style/CommentAnnotation:
|
|
Enabled: false
|
|
|
|
# Indentation of comments.
|
|
Style/CommentIndentation:
|
|
Enabled: true
|
|
|
|
# Check for `if` and `case` statements where each branch is used for
|
|
# assignment to the same variable when using the return of the
|
|
# condition can be used instead.
|
|
Style/ConditionalAssignment:
|
|
Enabled: true
|
|
|
|
# Constants should use SCREAMING_SNAKE_CASE.
|
|
Style/ConstantName:
|
|
Enabled: true
|
|
|
|
# Use def with parentheses when there are arguments.
|
|
Style/DefWithParentheses:
|
|
Enabled: true
|
|
|
|
# Document classes and non-namespace modules.
|
|
Style/Documentation:
|
|
Enabled: false
|
|
|
|
# This cop checks for uses of double negation (!!) to convert something
|
|
# to a boolean value. As this is both cryptic and usually redundant, it
|
|
# should be avoided.
|
|
Style/DoubleNegation:
|
|
Enabled: false
|
|
|
|
# Align elses and elsifs correctly.
|
|
Style/ElseAlignment:
|
|
Enabled: true
|
|
|
|
# Use empty lines between defs.
|
|
Style/EmptyLineBetweenDefs:
|
|
Enabled: true
|
|
|
|
# Don't use several empty lines in a row.
|
|
Style/EmptyLines:
|
|
Enabled: true
|
|
|
|
# Keep blank lines around access modifiers.
|
|
Style/EmptyLinesAroundAccessModifier:
|
|
Enabled: true
|
|
|
|
# Keeps track of empty lines around block bodies.
|
|
Style/EmptyLinesAroundBlockBody:
|
|
Enabled: true
|
|
|
|
# Keeps track of empty lines around class bodies.
|
|
Style/EmptyLinesAroundClassBody:
|
|
Enabled: true
|
|
|
|
# Keeps track of empty lines around method bodies.
|
|
Style/EmptyLinesAroundMethodBody:
|
|
Enabled: true
|
|
|
|
# Keeps track of empty lines around module bodies.
|
|
Style/EmptyLinesAroundModuleBody:
|
|
Enabled: true
|
|
|
|
# Avoid the use of END blocks.
|
|
Style/EndBlock:
|
|
Enabled: true
|
|
|
|
# Use Unix-style line endings.
|
|
Style/EndOfLine:
|
|
Enabled: true
|
|
|
|
# Favor the use of Fixnum#even? && Fixnum#odd?
|
|
Style/EvenOdd:
|
|
Enabled: true
|
|
|
|
# Use snake_case for source file names.
|
|
Style/FileName:
|
|
Enabled: true
|
|
|
|
# Checks for a line break before the first parameter in a multi-line method
|
|
# parameter definition.
|
|
Style/FirstMethodParameterLineBreak:
|
|
Enabled: true
|
|
|
|
# Checks for flip flops.
|
|
Style/FlipFlop:
|
|
Enabled: true
|
|
|
|
# Checks use of for or each in multiline loops.
|
|
Style/For:
|
|
Enabled: true
|
|
|
|
# Checks if there is a magic comment to enforce string literals
|
|
Style/FrozenStringLiteralComment:
|
|
Enabled: false
|
|
|
|
# Do not introduce global variables.
|
|
Style/GlobalVars:
|
|
Enabled: true
|
|
Exclude:
|
|
- 'lib/backup/**/*'
|
|
- 'lib/tasks/**/*'
|
|
|
|
# Prefer Ruby 1.9 hash syntax `{ a: 1, b: 2 }`
|
|
# over 1.8 syntax `{ :a => 1, :b => 2 }`.
|
|
Style/HashSyntax:
|
|
Enabled: true
|
|
|
|
# Checks that conditional statements do not have an identical line at the
|
|
# end of each branch, which can validly be moved out of the conditional.
|
|
Style/IdenticalConditionalBranches:
|
|
Enabled: true
|
|
|
|
# Do not use if x; .... Use the ternary operator instead.
|
|
Style/IfWithSemicolon:
|
|
Enabled: true
|
|
|
|
# Checks the indentation of the first line of the right-hand-side of a
|
|
# multi-line assignment.
|
|
Style/IndentAssignment:
|
|
Enabled: true
|
|
|
|
# Keep indentation straight.
|
|
Style/IndentationConsistency:
|
|
Enabled: true
|
|
|
|
# Use 2 spaces for indentation.
|
|
Style/IndentationWidth:
|
|
Enabled: true
|
|
|
|
# Use Kernel#loop for infinite loops.
|
|
Style/InfiniteLoop:
|
|
Enabled: true
|
|
|
|
# Use lambda.call(...) instead of lambda.(...).
|
|
Style/LambdaCall:
|
|
Enabled: true
|
|
|
|
# Comments should start with a space.
|
|
Style/LeadingCommentSpace:
|
|
Enabled: true
|
|
|
|
# Checks if the method definitions have or don't have parentheses.
|
|
Style/MethodDefParentheses:
|
|
Enabled: true
|
|
|
|
# Use the configured style when naming methods.
|
|
Style/MethodName:
|
|
Enabled: true
|
|
|
|
# Checks for usage of `extend self` in modules.
|
|
Style/ModuleFunction:
|
|
Enabled: false
|
|
|
|
# Checks that the closing brace in an array literal is either on the same line
|
|
# as the last array element, or a new line.
|
|
Style/MultilineArrayBraceLayout:
|
|
Enabled: true
|
|
EnforcedStyle: symmetrical
|
|
|
|
# Avoid multi-line chains of blocks.
|
|
Style/MultilineBlockChain:
|
|
Enabled: true
|
|
|
|
# Ensures newlines after multiline block do statements.
|
|
Style/MultilineBlockLayout:
|
|
Enabled: true
|
|
|
|
# Checks that the closing brace in a hash literal is either on the same line as
|
|
# the last hash element, or a new line.
|
|
Style/MultilineHashBraceLayout:
|
|
Enabled: true
|
|
EnforcedStyle: symmetrical
|
|
|
|
# Do not use then for multi-line if/unless.
|
|
Style/MultilineIfThen:
|
|
Enabled: true
|
|
|
|
# Checks that the closing brace in a method call is either on the same line as
|
|
# the last method argument, or a new line.
|
|
Style/MultilineMethodCallBraceLayout:
|
|
Enabled: false
|
|
EnforcedStyle: symmetrical
|
|
|
|
# Checks indentation of method calls with the dot operator that span more than
|
|
# one line.
|
|
Style/MultilineMethodCallIndentation:
|
|
Enabled: false
|
|
|
|
# Checks that the closing brace in a method definition is symmetrical with
|
|
# respect to the opening brace and the method parameters.
|
|
Style/MultilineMethodDefinitionBraceLayout:
|
|
Enabled: false
|
|
|
|
# Checks indentation of binary operations that span more than one line.
|
|
Style/MultilineOperationIndentation:
|
|
Enabled: true
|
|
EnforcedStyle: indented
|
|
|
|
# Avoid multi-line `? :` (the ternary operator), use if/unless instead.
|
|
Style/MultilineTernaryOperator:
|
|
Enabled: true
|
|
|
|
# This cop checks whether some constant value isn't a
|
|
# mutable literal (e.g. array or hash).
|
|
Style/MutableConstant:
|
|
Enabled: true
|
|
Exclude:
|
|
- 'db/migrate/**/*'
|
|
- 'db/post_migrate/**/*'
|
|
|
|
# Favor unless over if for negative conditions (or control flow or).
|
|
Style/NegatedIf:
|
|
Enabled: true
|
|
|
|
# Avoid using nested modifiers.
|
|
Style/NestedModifier:
|
|
Enabled: true
|
|
|
|
# Use one expression per branch in a ternary operator.
|
|
Style/NestedTernaryOperator:
|
|
Enabled: true
|
|
|
|
# Prefer x.nil? to x == nil.
|
|
Style/NilComparison:
|
|
Enabled: true
|
|
|
|
# Checks for redundant nil checks.
|
|
Style/NonNilCheck:
|
|
Enabled: true
|
|
|
|
# Use ! instead of not.
|
|
Style/Not:
|
|
Enabled: true
|
|
|
|
# Add underscores to large numeric literals to improve their readability.
|
|
Style/NumericLiterals:
|
|
Enabled: false
|
|
|
|
# Favor the ternary operator(?:) over if/then/else/end constructs.
|
|
Style/OneLineConditional:
|
|
Enabled: true
|
|
|
|
# When defining binary operators, name the argument other.
|
|
Style/OpMethod:
|
|
Enabled: true
|
|
|
|
# Don't use parentheses around the condition of an if/unless/while.
|
|
Style/ParenthesesAroundCondition:
|
|
Enabled: true
|
|
|
|
# Checks for an obsolete RuntimeException argument in raise/fail.
|
|
Style/RedundantException:
|
|
Enabled: true
|
|
|
|
# Checks for parentheses that seem not to serve any purpose.
|
|
Style/RedundantParentheses:
|
|
Enabled: true
|
|
|
|
# Don't use semicolons to terminate expressions.
|
|
Style/Semicolon:
|
|
Enabled: true
|
|
|
|
# Checks for proper usage of fail and raise.
|
|
Style/SignalException:
|
|
EnforcedStyle: only_raise
|
|
Enabled: true
|
|
|
|
# Use spaces after colons.
|
|
Style/SpaceAfterColon:
|
|
Enabled: true
|
|
|
|
# Use spaces after commas.
|
|
Style/SpaceAfterComma:
|
|
Enabled: true
|
|
|
|
# Do not put a space between a method name and the opening parenthesis in a
|
|
# method definition.
|
|
Style/SpaceAfterMethodName:
|
|
Enabled: true
|
|
|
|
# Tracks redundant space after the ! operator.
|
|
Style/SpaceAfterNot:
|
|
Enabled: true
|
|
|
|
# Use spaces after semicolons.
|
|
Style/SpaceAfterSemicolon:
|
|
Enabled: true
|
|
|
|
# Use space around equals in parameter default
|
|
Style/SpaceAroundEqualsInParameterDefault:
|
|
Enabled: true
|
|
|
|
# Use a space around keywords if appropriate.
|
|
Style/SpaceAroundKeyword:
|
|
Enabled: true
|
|
|
|
# Use a single space around operators.
|
|
Style/SpaceAroundOperators:
|
|
Enabled: true
|
|
|
|
# No spaces before commas.
|
|
Style/SpaceBeforeComma:
|
|
Enabled: true
|
|
|
|
# Checks for missing space between code and a comment on the same line.
|
|
Style/SpaceBeforeComment:
|
|
Enabled: true
|
|
|
|
# No spaces before semicolons.
|
|
Style/SpaceBeforeSemicolon:
|
|
Enabled: true
|
|
|
|
# Checks for spaces inside square brackets.
|
|
Style/SpaceInsideBrackets:
|
|
Enabled: true
|
|
|
|
# Use spaces inside hash literal braces - or don't.
|
|
Style/SpaceInsideHashLiteralBraces:
|
|
Enabled: true
|
|
|
|
# No spaces inside range literals.
|
|
Style/SpaceInsideRangeLiteral:
|
|
Enabled: true
|
|
|
|
# Checks for padding/surrounding spaces inside string interpolation.
|
|
Style/SpaceInsideStringInterpolation:
|
|
EnforcedStyle: no_space
|
|
Enabled: true
|
|
|
|
# Check for the usage of parentheses around stabby lambda arguments.
|
|
Style/StabbyLambdaParentheses:
|
|
EnforcedStyle: require_parentheses
|
|
Enabled: true
|
|
|
|
# Checks if uses of quotes match the configured preference.
|
|
Style/StringLiterals:
|
|
Enabled: false
|
|
|
|
# Checks if configured preferred methods are used over non-preferred.
|
|
Style/StringMethods:
|
|
PreferredMethods:
|
|
intern: to_sym
|
|
Enabled: true
|
|
|
|
# No hard tabs.
|
|
Style/Tab:
|
|
Enabled: true
|
|
|
|
# Checks trailing blank lines and final newline.
|
|
Style/TrailingBlankLines:
|
|
Enabled: true
|
|
|
|
# This cop checks for trailing comma in array and hash literals.
|
|
Style/TrailingCommaInLiteral:
|
|
Enabled: false
|
|
|
|
# Checks for %W when interpolation is not needed.
|
|
Style/UnneededCapitalW:
|
|
Enabled: true
|
|
|
|
# Checks for %q/%Q when single quotes or double quotes would do.
|
|
Style/UnneededPercentQ:
|
|
Enabled: false
|
|
|
|
# Don't interpolate global, instance and class variables directly in strings.
|
|
Style/VariableInterpolation:
|
|
Enabled: true
|
|
|
|
# Use the configured style when naming variables.
|
|
Style/VariableName:
|
|
EnforcedStyle: snake_case
|
|
Enabled: true
|
|
|
|
# Use the configured style when numbering variables.
|
|
Style/VariableNumber:
|
|
Enabled: false
|
|
|
|
# Use when x then ... for one-line cases.
|
|
Style/WhenThen:
|
|
Enabled: true
|
|
|
|
# Checks for redundant do after while or until.
|
|
Style/WhileUntilDo:
|
|
Enabled: true
|
|
|
|
# Favor modifier while/until usage when you have a single-line body.
|
|
Style/WhileUntilModifier:
|
|
Enabled: true
|
|
|
|
# Use %w or %W for arrays of words.
|
|
Style/WordArray:
|
|
Enabled: true
|
|
|
|
# Metrics #####################################################################
|
|
|
|
# A calculated magnitude based on number of assignments,
|
|
# branches, and conditions.
|
|
Metrics/AbcSize:
|
|
Enabled: true
|
|
Max: 60
|
|
|
|
# This cop checks if the length of a block exceeds some maximum value.
|
|
Metrics/BlockLength:
|
|
Enabled: false
|
|
|
|
# Avoid excessive block nesting.
|
|
Metrics/BlockNesting:
|
|
Enabled: true
|
|
Max: 4
|
|
|
|
# Avoid classes longer than 100 lines of code.
|
|
Metrics/ClassLength:
|
|
Enabled: false
|
|
|
|
# A complexity metric that is strongly correlated to the number
|
|
# of test cases needed to validate a method.
|
|
Metrics/CyclomaticComplexity:
|
|
Enabled: true
|
|
Max: 17
|
|
|
|
# Limit lines to 80 characters.
|
|
Metrics/LineLength:
|
|
Enabled: false
|
|
|
|
# Avoid methods longer than 10 lines of code.
|
|
Metrics/MethodLength:
|
|
Enabled: false
|
|
|
|
# Avoid modules longer than 100 lines of code.
|
|
Metrics/ModuleLength:
|
|
Enabled: false
|
|
|
|
# Avoid parameter lists longer than three or four parameters.
|
|
Metrics/ParameterLists:
|
|
Enabled: true
|
|
Max: 8
|
|
|
|
# A complexity metric geared towards measuring complexity for a human reader.
|
|
Metrics/PerceivedComplexity:
|
|
Enabled: true
|
|
Max: 18
|
|
|
|
# Lint ########################################################################
|
|
|
|
# Checks for ambiguous operators in the first argument of a method invocation
|
|
# without parentheses.
|
|
Lint/AmbiguousOperator:
|
|
Enabled: true
|
|
|
|
# This cop checks for ambiguous regexp literals in the first argument of
|
|
# a method invocation without parentheses.
|
|
Lint/AmbiguousRegexpLiteral:
|
|
Enabled: false
|
|
|
|
# This cop checks for assignments in the conditions of
|
|
# if/while/until.
|
|
Lint/AssignmentInCondition:
|
|
Enabled: false
|
|
|
|
# Align block ends correctly.
|
|
Lint/BlockAlignment:
|
|
Enabled: true
|
|
|
|
# Default values in optional keyword arguments and optional ordinal arguments
|
|
# should not refer back to the name of the argument.
|
|
Lint/CircularArgumentReference:
|
|
Enabled: true
|
|
|
|
# Checks for condition placed in a confusing position relative to the keyword.
|
|
Lint/ConditionPosition:
|
|
Enabled: true
|
|
|
|
# Check for debugger calls.
|
|
Lint/Debugger:
|
|
Enabled: true
|
|
|
|
# Align ends corresponding to defs correctly.
|
|
Lint/DefEndAlignment:
|
|
Enabled: true
|
|
|
|
# Check for deprecated class method calls.
|
|
Lint/DeprecatedClassMethods:
|
|
Enabled: true
|
|
|
|
# Check for immutable argument given to each_with_object.
|
|
Lint/EachWithObjectArgument:
|
|
Enabled: true
|
|
|
|
# Check for odd code arrangement in an else block.
|
|
Lint/ElseLayout:
|
|
Enabled: true
|
|
|
|
# Checks for empty ensure block.
|
|
Lint/EmptyEnsure:
|
|
Enabled: true
|
|
|
|
# Checks for the presence of `when` branches without a body.
|
|
Lint/EmptyWhen:
|
|
Enabled: true
|
|
|
|
# Align ends correctly.
|
|
Lint/EndAlignment:
|
|
Enabled: true
|
|
|
|
# END blocks should not be placed inside method definitions.
|
|
Lint/EndInMethod:
|
|
Enabled: true
|
|
|
|
# Do not use return in an ensure block.
|
|
Lint/EnsureReturn:
|
|
Enabled: true
|
|
|
|
# Catches floating-point literals too large or small for Ruby to represent.
|
|
Lint/FloatOutOfRange:
|
|
Enabled: true
|
|
|
|
# The number of parameters to format/sprint must match the fields.
|
|
Lint/FormatParameterMismatch:
|
|
Enabled: true
|
|
|
|
# This cop checks for *rescue* blocks with no body.
|
|
Lint/HandleExceptions:
|
|
Enabled: false
|
|
|
|
# Checks for adjacent string literals on the same line, which could better be
|
|
# represented as a single string literal.
|
|
Lint/ImplicitStringConcatenation:
|
|
Enabled: true
|
|
|
|
# Checks for attempts to use `private` or `protected` to set the visibility
|
|
# of a class method, which does not work.
|
|
Lint/IneffectiveAccessModifier:
|
|
Enabled: false
|
|
|
|
# Checks for invalid character literals with a non-escaped whitespace
|
|
# character.
|
|
Lint/InvalidCharacterLiteral:
|
|
Enabled: true
|
|
|
|
# Checks of literals used in conditions.
|
|
Lint/LiteralInCondition:
|
|
Enabled: true
|
|
|
|
# Checks for literals used in interpolation.
|
|
Lint/LiteralInInterpolation:
|
|
Enabled: true
|
|
|
|
# This cop checks for uses of *begin...end while/until something*.
|
|
Lint/Loop:
|
|
Enabled: false
|
|
|
|
# Do not use nested method definitions.
|
|
Lint/NestedMethodDefinition:
|
|
Enabled: true
|
|
|
|
# Do not omit the accumulator when calling `next` in a `reduce`/`inject` block.
|
|
Lint/NextWithoutAccumulator:
|
|
Enabled: true
|
|
|
|
# Checks for method calls with a space before the opening parenthesis.
|
|
Lint/ParenthesesAsGroupedExpression:
|
|
Enabled: true
|
|
|
|
# Checks for `rand(1)` calls. Such calls always return `0` and most likely
|
|
# a mistake.
|
|
Lint/RandOne:
|
|
Enabled: true
|
|
|
|
# Use parentheses in the method call to avoid confusion about precedence.
|
|
Lint/RequireParentheses:
|
|
Enabled: true
|
|
|
|
# Avoid rescuing the Exception class.
|
|
Lint/RescueException:
|
|
Enabled: true
|
|
|
|
# Checks for the order which exceptions are rescued to avoid rescueing a less specific exception before a more specific exception.
|
|
Lint/ShadowedException:
|
|
Enabled: false
|
|
|
|
# This cop looks for use of the same name as outer local variables
|
|
# for block arguments or block local variables.
|
|
Lint/ShadowingOuterLocalVariable:
|
|
Enabled: false
|
|
|
|
# Checks for Object#to_s usage in string interpolation.
|
|
Lint/StringConversionInInterpolation:
|
|
Enabled: true
|
|
|
|
# Do not use prefix `_` for a variable that is used.
|
|
Lint/UnderscorePrefixedVariableName:
|
|
Enabled: true
|
|
|
|
# This cop checks for using Fixnum or Bignum constant
|
|
Lint/UnifiedInteger:
|
|
Enabled: true
|
|
|
|
# Checks for rubocop:disable comments that can be removed.
|
|
# Note: this cop is not disabled when disabling all cops.
|
|
# It must be explicitly disabled.
|
|
Lint/UnneededDisable:
|
|
Enabled: false
|
|
|
|
# This cop checks for unneeded usages of splat expansion
|
|
Lint/UnneededSplatExpansion:
|
|
Enabled: false
|
|
|
|
# Unreachable code.
|
|
Lint/UnreachableCode:
|
|
Enabled: true
|
|
|
|
# This cop checks for unused block arguments.
|
|
Lint/UnusedBlockArgument:
|
|
Enabled: false
|
|
|
|
# This cop checks for unused method arguments.
|
|
Lint/UnusedMethodArgument:
|
|
Enabled: false
|
|
|
|
# Checks for useless access modifiers.
|
|
Lint/UselessAccessModifier:
|
|
Enabled: true
|
|
|
|
# Checks for useless assignment to a local variable.
|
|
Lint/UselessAssignment:
|
|
Enabled: true
|
|
|
|
# Checks for comparison of something with itself.
|
|
Lint/UselessComparison:
|
|
Enabled: true
|
|
|
|
# Checks for useless `else` in `begin..end` without `rescue`.
|
|
Lint/UselessElseWithoutRescue:
|
|
Enabled: true
|
|
|
|
# Checks for useless setter call to a local variable.
|
|
Lint/UselessSetterCall:
|
|
Enabled: true
|
|
|
|
# Possible use of operator/literal/variable in void context.
|
|
Lint/Void:
|
|
Enabled: true
|
|
|
|
# Performance #################################################################
|
|
|
|
# Use `casecmp` rather than `downcase ==`.
|
|
Performance/Casecmp:
|
|
Enabled: true
|
|
|
|
# Use `str.{start,end}_with?(x, ..., y, ...)` instead of
|
|
# `str.{start,end}_with?(x, ...) || str.{start,end}_with?(y, ...)`.
|
|
Performance/DoubleStartEndWith:
|
|
Enabled: true
|
|
|
|
# Use `strip` instead of `lstrip.rstrip`.
|
|
Performance/LstripRstrip:
|
|
Enabled: true
|
|
|
|
# Use `Range#cover?` instead of `Range#include?`.
|
|
Performance/RangeInclude:
|
|
Enabled: true
|
|
|
|
# This cop identifies the use of a `&block` parameter and `block.call`
|
|
# where `yield` would do just as well.
|
|
Performance/RedundantBlockCall:
|
|
Enabled: true
|
|
|
|
# This cop identifies use of `Regexp#match` or `String#match in a context
|
|
# where the integral return value of `=~` would do just as well.
|
|
Performance/RedundantMatch:
|
|
Enabled: true
|
|
|
|
# This cop identifies places where `Hash#merge!` can be replaced by
|
|
# `Hash#[]=`.
|
|
Performance/RedundantMerge:
|
|
Enabled: true
|
|
MaxKeyValuePairs: 1
|
|
|
|
# Use `sort` instead of `sort_by { |x| x }`.
|
|
Performance/RedundantSortBy:
|
|
Enabled: true
|
|
|
|
# Use `start_with?` instead of a regex match anchored to the beginning of a
|
|
# string.
|
|
Performance/StartWith:
|
|
Enabled: true
|
|
|
|
# Use `tr` instead of `gsub` when you are replacing the same number of
|
|
# characters. Use `delete` instead of `gsub` when you are deleting
|
|
# characters.
|
|
Performance/StringReplacement:
|
|
Enabled: true
|
|
|
|
# Checks for `.times.map` calls.
|
|
Performance/TimesMap:
|
|
Enabled: true
|
|
|
|
# Security ####################################################################
|
|
|
|
# This cop checks for the use of JSON class methods which have potential
|
|
# security issues.
|
|
Security/JSONLoad:
|
|
Enabled: true
|
|
|
|
# This cop checks for the use of *Kernel#eval*.
|
|
Security/Eval:
|
|
Enabled: true
|
|
|
|
# Rails #######################################################################
|
|
|
|
# Enables Rails cops.
|
|
Rails:
|
|
Enabled: true
|
|
|
|
# Enforces consistent use of action filter methods.
|
|
Rails/ActionFilter:
|
|
Enabled: true
|
|
EnforcedStyle: action
|
|
|
|
# Checks the correct usage of date aware methods, such as `Date.today`,
|
|
# `Date.current`, etc.
|
|
Rails/Date:
|
|
Enabled: false
|
|
|
|
# Prefer delegate method for delegations.
|
|
Rails/Delegate:
|
|
Enabled: true
|
|
|
|
# This cop checks dynamic `find_by_*` methods.
|
|
Rails/DynamicFindBy:
|
|
Enabled: false
|
|
|
|
# This cop enforces that 'exit' calls are not used within a rails app.
|
|
Rails/Exit:
|
|
Enabled: true
|
|
Exclude:
|
|
- lib/gitlab/upgrader.rb
|
|
- 'lib/backup/**/*'
|
|
|
|
# Prefer `find_by` over `where.first`.
|
|
Rails/FindBy:
|
|
Enabled: true
|
|
|
|
# Prefer `all.find_each` over `all.find`.
|
|
Rails/FindEach:
|
|
Enabled: true
|
|
|
|
# Prefer has_many :through to has_and_belongs_to_many.
|
|
Rails/HasAndBelongsToMany:
|
|
Enabled: true
|
|
|
|
# This cop is used to identify usages of http methods like `get`, `post`,
|
|
# `put`, `patch` without the usage of keyword arguments in your tests and
|
|
# change them to use keyword args.
|
|
Rails/HttpPositionalArguments:
|
|
Enabled: false
|
|
|
|
# Checks for calls to puts, print, etc.
|
|
Rails/Output:
|
|
Enabled: true
|
|
Exclude:
|
|
- lib/gitlab/seeder.rb
|
|
- lib/gitlab/upgrader.rb
|
|
- 'lib/backup/**/*'
|
|
- 'lib/tasks/**/*'
|
|
|
|
# This cop checks for the use of output safety calls like html_safe and
|
|
# raw.
|
|
Rails/OutputSafety:
|
|
Enabled: false
|
|
|
|
# Checks for incorrect grammar when using methods like `3.day.ago`.
|
|
Rails/PluralizationGrammar:
|
|
Enabled: true
|
|
|
|
# Checks for `read_attribute(:attr)` and `write_attribute(:attr, val)`.
|
|
Rails/ReadWriteAttribute:
|
|
Enabled: false
|
|
|
|
# Checks the arguments of ActiveRecord scopes.
|
|
Rails/ScopeArgs:
|
|
Enabled: true
|
|
|
|
# This cop checks for the use of Time methods without zone.
|
|
Rails/TimeZone:
|
|
Enabled: false
|
|
|
|
# This cop checks for the use of old-style attribute validation macros.
|
|
Rails/Validation:
|
|
Enabled: true
|
|
|
|
# RSpec #######################################################################
|
|
|
|
# Check that instances are not being stubbed globally.
|
|
RSpec/AnyInstance:
|
|
Enabled: false
|
|
|
|
# Check for expectations where `be(...)` can replace `eql(...)`.
|
|
RSpec/BeEql:
|
|
Enabled: false
|
|
|
|
# Check that the first argument to the top level describe is the tested class or
|
|
# module.
|
|
RSpec/DescribeClass:
|
|
Enabled: false
|
|
|
|
# Use `described_class` for tested class / module.
|
|
RSpec/DescribeMethod:
|
|
Enabled: false
|
|
|
|
# Checks that the second argument to top level describe is the tested method
|
|
# name.
|
|
RSpec/DescribedClass:
|
|
Enabled: false
|
|
|
|
# Checks for long example.
|
|
RSpec/ExampleLength:
|
|
Enabled: false
|
|
Max: 5
|
|
|
|
# Do not use should when describing your tests.
|
|
RSpec/ExampleWording:
|
|
Enabled: false
|
|
CustomTransform:
|
|
be: is
|
|
have: has
|
|
not: does not
|
|
IgnoredWords: []
|
|
|
|
# Checks for `expect(...)` calls containing literal values.
|
|
RSpec/ExpectActual:
|
|
Enabled: true
|
|
|
|
# Checks the file and folder naming of the spec file.
|
|
RSpec/FilePath:
|
|
Enabled: false
|
|
CustomTransform:
|
|
RuboCop: rubocop
|
|
RSpec: rspec
|
|
|
|
# Checks if there are focused specs.
|
|
RSpec/Focus:
|
|
Enabled: true
|
|
|
|
# Checks for the usage of instance variables.
|
|
RSpec/InstanceVariable:
|
|
Enabled: false
|
|
|
|
# Checks for `subject` definitions that come after `let` definitions.
|
|
RSpec/LeadingSubject:
|
|
Enabled: false
|
|
|
|
# Checks unreferenced `let!` calls being used for test setup.
|
|
RSpec/LetSetup:
|
|
Enabled: false
|
|
|
|
# Check that chains of messages are not being stubbed.
|
|
RSpec/MessageChain:
|
|
Enabled: false
|
|
|
|
# Checks that message expectations are set using spies.
|
|
RSpec/MessageSpies:
|
|
Enabled: false
|
|
|
|
# Checks for multiple top-level describes.
|
|
RSpec/MultipleDescribes:
|
|
Enabled: false
|
|
|
|
# Checks if examples contain too many `expect` calls.
|
|
RSpec/MultipleExpectations:
|
|
Enabled: false
|
|
|
|
# Checks for explicitly referenced test subjects.
|
|
RSpec/NamedSubject:
|
|
Enabled: false
|
|
|
|
# Checks for nested example groups.
|
|
RSpec/NestedGroups:
|
|
Enabled: false
|
|
|
|
# Enforces the usage of the same method on all negative message expectations.
|
|
RSpec/NotToNot:
|
|
EnforcedStyle: not_to
|
|
Enabled: true
|
|
|
|
# Check for repeated description strings in example groups.
|
|
RSpec/RepeatedDescription:
|
|
Enabled: false
|
|
|
|
# Checks for stubbed test subjects.
|
|
RSpec/SubjectStub:
|
|
Enabled: false
|
|
|
|
# Prefer using verifying doubles over normal doubles.
|
|
RSpec/VerifiedDoubles:
|
|
Enabled: false
|