Skip to content
Snippets Groups Projects
.rubocop.yml 26.2 KiB
Newer Older
  • Learn to ignore specific revisions
  • Robert Speicher's avatar
    Robert Speicher committed
    require: rubocop-rspec
    
    
    AllCops:
      TargetRubyVersion: 2.1
      # Cop names are not displayed 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/**/*'
        - 'db/**/*'
        - 'tmp/**/*'
        - 'bin/**/*'
        - 'lib/backup/**/*'
        - 'lib/ci/backup/**/*'
        - 'lib/tasks/**/*'
        - 'lib/ci/migrate/**/*'
        - 'lib/email_validator.rb'
        - 'lib/gitlab/upgrader.rb'
        - 'lib/gitlab/seeder.rb'
    
        - 'generator_templates/**/*'
    
    
    
    ##################### Style ##################################
    
    # Check indentation of private/protected visibility modifiers.
    
    Style/AccessModifierIndentation:
    
    # Check the naming of accessor methods for get_/set_.
    
    # Use alias_method instead of alias.
    
      EnforcedStyle: prefer_alias_method
    
      Enabled: true
    
    # Align the elements of an array literal if they span more than one line.
    
      Enabled: true
    
    # Align the elements of a hash literal if they span more than one line.
    
      Enabled: true
    
    # Align the parameters of a method call if they span more than one line.
    
    # Use &&/|| instead of and/or.
    
    # Use `Array#join` instead of `Array#*`.
    
    # Use only ascii symbols in comments.
    
      Enabled: true
    
    # Use only ascii symbols in identifiers.
    
      Enabled: true
    
    # Checks for uses of Module#attr.
    
    # Avoid the use of BEGIN blocks.
    
      Enabled: true
    
    # Checks if usage of %() or %Q() matches configuration.
    
    Style/BarePercentLiterals:
      Enabled: false
    
    
    # Do not use block comments.
    
    # Put end statement of multiline block on its own line.
    
    # Avoid using {...} for multi-line blocks (multiline chaining is # always
    # ugly). Prefer {...} over do...end for single-line blocks.
    
    Style/BlockDelimiters:
    
    # Enforce braces style around hash parameters.
    
    Style/BracesAroundHashParameters:
      Enabled: false
    
    
    # Avoid explicit use of the case equality operator(===).
    
    # Indentation of when in a case/when/[else/]end.
    
    # Checks for uses of character literals.
    
      Enabled: true
    
    # Use CamelCase for classes and modules.'
    
      Enabled: true
    
    # Checks style of children classes and modules.
    
    Style/ClassAndModuleChildren:
      Enabled: false
    
    
    # Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
    
    # Use self when defining module/class methods.
    
    # Avoid the use of class variables.
    
      Enabled: true
    
    # Do not use :: for method call.
    
    # Checks formatting of special comments (TODO, FIXME, OPTIMIZE, HACK, REVIEW).
    
    # Indentation of comments.
    
      Enabled: true
    
    # Use the return value of `if` and `case` statements for assignment to a
    # variable and variable comparison instead of assigning that variable
    # inside of each branch.
    Style/ConditionalAssignment:
      Enabled: false
    
    # Constants should use SCREAMING_SNAKE_CASE.
    
    # Use def with parentheses when there are arguments.
    
    # Checks for use of deprecated Hash methods.
    
    Style/DeprecatedHashMethods:
      Enabled: false
    
    
    # Document classes and non-namespace modules.
    
    # Checks the position of the dot in multi-line method calls.
    
    # Checks for uses of double negation (!!).
    
    # Prefer `each_with_object` over `inject` or `reduce`.
    
    # Align elses and elsifs correctly.
    
    # Avoid empty else-clauses.
    
    # Use empty lines between defs.
    
    Style/EmptyLineBetweenDefs:
      Enabled: false
    
    
    # Don't use several empty lines in a row.
    
    # Keep blank lines around access modifiers.
    
    Style/EmptyLinesAroundAccessModifier:
      Enabled: false
    
    
    # Keeps track of empty lines around block bodies.
    
    Style/EmptyLinesAroundBlockBody:
      Enabled: false
    
    
    # Keeps track of empty lines around class bodies.
    
    Style/EmptyLinesAroundClassBody:
      Enabled: false
    
    
    # Keeps track of empty lines around module bodies.
    
    Style/EmptyLinesAroundModuleBody:
      Enabled: false
    
    
    # Keeps track of empty lines around method bodies.
    
    Style/EmptyLinesAroundMethodBody:
      Enabled: false
    
    
    # Prefer literals to Array.new/Hash.new/String.new.
    
    # Avoid the use of END blocks.
    
    # Use Unix-style line endings.
    
    # Favor the use of Fixnum#even? && Fixnum#odd?
    
    # Do not use unnecessary spacing.
    
    Style/ExtraSpacing:
      Enabled: false
    
    
    # Use snake_case for source file names.
    
    # Checks for flip flops.
    
    # Checks use of for or each in multiline loops.
    
    # Enforce the use of Kernel#sprintf, Kernel#format or String#%.
    
    # Do not introduce global variables.
    
    # Check for conditionals that can be replaced with guard clauses.
    
    # Prefer Ruby 1.9 hash syntax `{ a: 1, b: 2 }`
    # over 1.8 syntax `{ :a => 1, :b => 2 }`.
    
      Enabled: true
    
    # Finds if nodes inside else, which can be converted to elsif.
    Style/IfInsideElse:
      Enabled: false
    
    # Favor modifier if/unless usage when you have a single-line body.
    
    # Do not use if x; .... Use the ternary operator instead.
    
    # 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: false
    
    # Checks the indentation of the first line of the right-hand-side of a
    
    # multi-line assignment.
    
    Style/IndentAssignment:
      Enabled: false
    
    # Keep indentation straight.
    
      Enabled: true
    
    # Use 2 spaces for indentation.
    
      Enabled: true
    
    # Checks the indentation of the first element in an array literal.
    
    # Checks the indentation of the first key in a hash literal.
    
    # Use Kernel#loop for infinite loops.
    
      Enabled: true
    
    # Use the new lambda literal syntax for single-line blocks.
    
    # Use lambda.call(...) instead of lambda.(...).
    
    # Comments should start with a space.
    
    Style/LeadingCommentSpace:
      Enabled: false
    
    
    # Use \ instead of + or << to concatenate two string literals at line end.
    
    Style/LineEndConcatenation:
      Enabled: false
    
    
    # Do not use parentheses for method calls with no arguments.
    
    Style/MethodCallParentheses:
      Enabled: false
    
    
    # Checks if the method definitions have or don't have parentheses.
    
    Style/MethodDefParentheses:
      Enabled: false
    
    
    # Use the configured style when naming methods.
    
    # Checks for usage of `extend self` in modules.
    
    # 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: false
      EnforcedStyle: symmetrical
    
    
    # Avoid multi-line chains of blocks.
    
    Style/MultilineBlockChain:
      Enabled: false
    
    
    # Ensures newlines after multiline block do statements.
    
      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: false
      EnforcedStyle: symmetrical
    
    
    # Do not use then for multi-line if/unless.
    
    # 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 indentation of binary operations that span more than one line.
    
    Style/MultilineOperationIndentation:
      Enabled: false
    
    
    # Avoid multi-line `? :` (the ternary operator), use if/unless instead.
    
    Style/MultilineTernaryOperator:
      Enabled: false
    
    
    # Do not assign mutable objects to constants.
    Style/MutableConstant:
      Enabled: false
    
    # Favor unless over if for negative conditions (or control flow or).
    
    # Favor until over while for negative conditions.
    
    # Avoid using nested modifiers.
    Style/NestedModifier:
      Enabled: false
    
    # Parenthesize method calls which are nested inside the argument list of
    # another parenthesized method call.
    Style/NestedParenthesizedCalls:
      Enabled: false
    
    # Use one expression per branch in a ternary operator.
    
      Enabled: true
    
    # Use `next` to skip iteration instead of a condition at the end.
    
    # Prefer x.nil? to x == nil.
    
      Enabled: true
    
    # Checks for redundant nil checks.
    
      Enabled: true
    
    # Use ! instead of not.
    
      Enabled: true
    
    # Add underscores to large numeric literals to improve their readability.
    
    # Favor the ternary operator(?:) over if/then/else/end constructs.
    
      Enabled: true
    
    # When defining binary operators, name the argument other.
    
    # Check for simple usages of parallel assignment. It will only warn when
    # the number of variables matches on both sides of the assignment.
    
    Style/ParallelAssignment:
      Enabled: false
    
    
    # Don't use parentheses around the condition of an if/unless/while.
    
    Style/ParenthesesAroundCondition:
    
      Enabled: true
    
    # Use `%`-literal delimiters consistently.
    
    Style/PercentLiteralDelimiters:
      Enabled: false
    
    
    # Checks if uses of %Q/%q match the configured preference.
    
    # Avoid Perl-style regex back references.
    
    # Check the names of predicate methods.
    
    # Use proc instead of Proc.new.
    
    # Checks the arguments passed to raise/fail.
    
    # Don't use begin blocks when they are not needed.
    
    # Checks for an obsolete RuntimeException argument in raise/fail.
    
    # Checks usages of Object#freeze on immutable objects.
    Style/RedundantFreeze:
      Enabled: false
    
    # TODO: Enable RedundantParentheses Cop.
    # Checks for parentheses that seem not to serve any purpose.
    Style/RedundantParentheses:
      Enabled: false
    
    # Don't use return where it's not required.
    
      Enabled: true
    
    # Don't use self where it's not needed.
    
    # Use %r for regular expressions matching more than `MaxSlashes` '/'
    # characters. Use %r only for regular expressions matching more
    # than `MaxSlashes` '/' character.
    
    # Avoid using rescue in its modifier form.
    
    # Checks for places where self-assignment shorthand should have been used.
    
    # Don't use semicolons to terminate expressions.
    
    # Checks for proper usage of fail and raise.
    
    # Enforces the names of some block params.
    
    Style/SingleLineBlockParams:
      Enabled: false
    
    
    # Avoid single-line methods.
    
    # Use spaces after colons.
    
    # Use spaces after commas.
    
    # Do not put a space between a method name and the opening parenthesis in a
    # method definition.
    
    Style/SpaceAfterMethodName:
      Enabled: false
    
    
    # Tracks redundant space after the ! operator.
    
    # Use spaces after semicolons.
    
    Style/SpaceAfterSemicolon:
      Enabled: false
    
    
    # Checks that the equals signs in parameter default assignments have or don't
    # have surrounding space depending on configuration.
    Style/SpaceAroundEqualsInParameterDefault:
    
    # Use a space around keywords if appropriate.
    Style/SpaceAroundKeyword:
    
    # Use a single space around operators.
    Style/SpaceAroundOperators:
    
      Enabled: true
    
    # Checks that the left block brace has or doesn't have space before it.
    Style/SpaceBeforeBlockBraces:
    
    # No spaces before commas.
    Style/SpaceBeforeComma:
    
    # Checks for missing space between code and a comment on the same line.
    Style/SpaceBeforeComment:
    
    # Checks that exactly one space is used between a method name and the first
    # argument for method calls without parentheses.
    Style/SpaceBeforeFirstArg:
      Enabled: false
    
    # No spaces before semicolons.
    Style/SpaceBeforeSemicolon:
    
    # Checks that block braces have or don't have surrounding space.
    # For blocks taking parameters, checks that the left brace has or doesn't
    # have trailing space.
    Style/SpaceInsideBlockBraces:
    
    # No spaces after [ or before ].
    
    Style/SpaceInsideBrackets:
      Enabled: false
    
    
    # Use spaces inside hash literal braces - or don't.
    
    Style/SpaceInsideHashLiteralBraces:
    
    # No spaces after ( or before ).
    
    # No spaces inside range literals.
    
    Style/SpaceInsideRangeLiteral:
      Enabled: false
    
    
    # Checks for padding/surrounding spaces inside string interpolation.
    Style/SpaceInsideStringInterpolation:
      Enabled: false
    
    # Avoid Perl-style global variables.
    
    # Check for the usage of parentheses around stabby lambda arguments.
    Style/StabbyLambdaParentheses:
      Enabled: false
    
    # Checks if uses of quotes match the configured preference.
    
    # Checks if uses of quotes inside expressions in interpolated strings match the
    # configured preference.
    
    Style/StringLiteralsInInterpolation:
      Enabled: false
    
    
    # Checks if configured preferred methods are used over non-preferred.
    Style/StringMethods:
      Enabled: false
    
    # Use %i or %I for arrays of symbols.
    Style/SymbolArray:
      Enabled: false
    
    # Use symbols as procs instead of blocks when possible.
    
    # No hard tabs.
    
    Dmitriy Zaporozhets's avatar
    Dmitriy Zaporozhets committed
      Enabled: true
    
    # Checks trailing blank lines and final newline.
    
      Enabled: true
    
    # Checks for trailing comma in array and hash literals.
    Style/TrailingCommaInLiteral:
    
    # Checks for trailing comma in argument lists.
    Style/TrailingCommaInArguments:
      Enabled: false
    
    # Avoid trailing whitespace.
    
    # Checks for the usage of unneeded trailing underscores at the end of
    # parallel variable assignment.
    
    Style/TrailingUnderscoreVariable:
      Enabled: false
    
    
    # Prefer attr_* methods to trivial readers/writers.
    
    # Do not use unless with else. Rewrite these with the positive case first.
    
    # Checks for %W when interpolation is not needed.
    
    # TODO: Enable UnneededInterpolation Cop.
    # Checks for strings that are just an interpolated expression.
    Style/UnneededInterpolation:
      Enabled: false
    
    # Checks for %q/%Q when single quotes or double quotes would do.
    
    # Don't interpolate global, instance and class variables directly in strings.
    
    Style/VariableInterpolation:
      Enabled: false
    
    
    # Use the configured style when naming variables.
    
    # Use when x then ... for one-line cases.
    
    # Checks for redundant do after while or until.
    
    # Favor modifier while/until usage when you have a single-line body.
    
    # Use %w or %W for arrays of words.
    
    # TODO: Enable ZeroLengthPredicate Cop.
    # Use #empty? when testing for objects of length 0.
    Style/ZeroLengthPredicate:
      Enabled: false
    
    
    
    #################### Metrics ################################
    
    
    # A calculated magnitude based on number of assignments,
    # branches, and conditions.
    
    Grzegorz Bizon's avatar
    Grzegorz Bizon committed
      Enabled: true
    
    # Avoid excessive block nesting.
    
    Grzegorz Bizon's avatar
    Grzegorz Bizon committed
      Enabled: true
      Max: 4
    
    # Avoid classes longer than 100 lines of code.
    
    # 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.
    
    # Avoid methods longer than 10 lines of code.
    
    # 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.
    
    # Checks for ambiguous regexp literals in the first argument of a method
    # invocation without parentheses.
    
    Lint/AmbiguousRegexpLiteral:
      Enabled: false
    
    
    # Don't use assignment in conditions.
    
    Lint/AssignmentInCondition:
      Enabled: false
    
    
    # Align block ends correctly.
    
    # Default values in optional keyword arguments and optional ordinal arguments
    # should not refer back to the name of the argument.
    Lint/CircularArgumentReference:
    
    
    # Checks for condition placed in a confusing position relative to the keyword.
    
    # Check for debugger calls.
    
    # Align ends corresponding to defs correctly.
    
    # Check for deprecated class method calls.
    
    # Check for duplicate method definitions.
    Lint/DuplicateMethods:
      Enabled: false
    
    # Check for duplicate keys in hash literals.
    Lint/DuplicatedKey:
      Enabled: false
    
    # Check for immutable argument given to each_with_object.
    Lint/EachWithObjectArgument:
    
    
    # Check for odd code arrangement in an else block.
    
    # Checks for empty ensure block.
    
    # Checks for empty string interpolation.
    
    # Align ends correctly.
    
    # END blocks should not be placed inside method definitions.
    
    # Do not use return in an ensure block.
    
    # The use of eval represents a serious security risk.
    
    # Catches floating-point literals too large or small for Ruby to represent.
    Lint/FloatOutOfRange:
    
    
    # The number of parameters to format/sprint must match the fields.
    Lint/FormatParameterMismatch:
    
    
    # Don't suppress exception.
    
    # Checks for adjacent string literals on the same line, which could better be
    # represented as a single string literal.
    Lint/ImplicitStringConcatenation:
    
    
    # TODO: Enable IneffectiveAccessModifier Cop.
    # 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.
    
    # Checks of literals used in conditions.
    
    # Checks for literals used in interpolation.
    
    # Use Kernel#loop with break rather than begin/end/until or begin/end/while
    # for post-loop tests.
    
    # Do not use nested method definitions.
    Lint/NestedMethodDefinition:
    
    
    # Do not omit the accumulator when calling `next` in a `reduce`/`inject` block.
    Lint/NextWithoutAccumulator:
    
    
    # Checks for method calls with a space before the opening parenthesis.
    
    Lint/ParenthesesAsGroupedExpression:
    
    # Checks for `rand(1)` calls. Such calls always return `0` and most likely
    # a mistake.
    Lint/RandOne:
    
    
    # Use parentheses in the method call to avoid confusion about precedence.
    
    # Avoid rescuing the Exception class.
    
      Enabled: true
    
    # Do not use the same name as outer local variable for block arguments
    # or block local variables.
    
    Lint/ShadowingOuterLocalVariable:
      Enabled: false
    
    
    # 'Checks for Object#to_s usage in string interpolation.
    
    Lint/StringConversionInInterpolation:
      Enabled: false
    
    
    # Do not use prefix `_` for a variable that is used.
    
    Lint/UnderscorePrefixedVariableName:
    
      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
    
    # Checks for unused block arguments.
    
    # Checks for unused method arguments.
    
    Lint/UnusedMethodArgument:
      Enabled: false
    
    
    # Unreachable code.
    
    # Checks for useless access modifiers.
    
    Lint/UselessAccessModifier:
      Enabled: false
    
    
    # Checks for useless assignment to a local variable.
    
    # Checks for comparison of something with itself.
    
    # Checks for useless `else` in `begin..end` without `rescue`.
    
    # Checks for useless setter call to a local variable.
    
    # Possible use of operator/literal/variable in void context.
    
    
    ##################### 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:
    
    
    # TODO: Enable EndWith Cop.
    # Use `end_with?` instead of a regex match anchored to the end of a string.
    Performance/EndWith:
      Enabled: false
    
    # Use `strip` instead of `lstrip.rstrip`.
    Performance/LstripRstrip:
    
    Connor Shea's avatar
    Connor Shea committed
      Enabled: true
    
    
    # Use `Range#cover?` instead of `Range#include?`.
    Performance/RangeInclude:
    
    
    # TODO: Enable RedundantBlockCall Cop.
    # Use `yield` instead of `block.call`.
    Performance/RedundantBlockCall:
      Enabled: false
    
    # TODO: Enable RedundantMatch Cop.
    # Use `=~` instead of `String#match` or `Regexp#match` in a context where the
    # returned `MatchData` is not needed.
    Performance/RedundantMatch:
      Enabled: false
    
    # TODO: Enable RedundantMerge Cop.
    # Use `Hash#[]=`, rather than `Hash#merge!` with a single key-value pair.
    Performance/RedundantMerge:
      # Max number of key-value pairs to consider an offense
      MaxKeyValuePairs: 2
      Enabled: false
    
    # Use `sort` instead of `sort_by { |x| x }`.
    Performance/RedundantSortBy: