Last active
November 28, 2022 19:16
-
-
Save dfop02/779aec549571a1fb3e08f5b77f8427e9 to your computer and use it in GitHub Desktop.
My personal rubocop config
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AllCops: | |
TargetRubyVersion: 2.7 | |
require: | |
- rubocop-performance | |
- rubocop-rails | |
- rubocop-rspec | |
#################### Lint ################################ | |
Lint/AmbiguousOperator: | |
Description: >- | |
Checks for ambiguous operators in the first argument of a | |
method invocation without parentheses. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-as-args' | |
Enabled: true | |
Lint/AmbiguousRegexpLiteral: | |
Description: >- | |
Checks for ambiguous regexp literals in the first argument of | |
a method invocation without parenthesis. | |
Enabled: true | |
Lint/AssignmentInCondition: | |
Description: "Don't use assignment in conditions." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition' | |
Enabled: true | |
Lint/CircularArgumentReference: | |
Description: "Don't refer to the keyword argument in the default value." | |
Enabled: true | |
Lint/FlipFlop: | |
Description: 'Checks for flip flops' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-flip-flops' | |
Enabled: false | |
Lint/Debugger: | |
Description: 'Check for debugger calls.' | |
Enabled: true | |
Lint/DeprecatedClassMethods: | |
Description: 'Check for deprecated class method calls.' | |
Enabled: true | |
Lint/DuplicateMethods: | |
Description: 'Check for duplicate methods calls.' | |
Enabled: true | |
Lint/EachWithObjectArgument: | |
Description: 'Check for immutable argument given to each_with_object.' | |
Enabled: true | |
Lint/ElseLayout: | |
Description: 'Check for odd code arrangement in an else block.' | |
Enabled: true | |
Lint/EmptyEnsure: | |
Description: 'Checks for empty ensure block.' | |
Enabled: true | |
Lint/EmptyInterpolation: | |
Description: 'Checks for empty string interpolation.' | |
Enabled: true | |
Lint/EnsureReturn: | |
Description: 'Do not use return in an ensure block.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-return-ensure' | |
Enabled: true | |
Lint/FormatParameterMismatch: | |
Description: 'The number of parameters to format/sprint must match the fields.' | |
Enabled: true | |
Lint/SuppressedException: | |
Description: "Don't suppress exception." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions' | |
Enabled: true | |
Lint/LiteralInInterpolation: | |
Description: 'Checks for literals used in interpolation.' | |
Enabled: true | |
Lint/Loop: | |
Description: >- | |
Use Kernel#loop with break rather than begin/end/until or | |
begin/end/while for post-loop tests. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#loop-with-break' | |
Enabled: true | |
Lint/NestedMethodDefinition: | |
Description: 'Do not use nested method definitions.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-methods' | |
Enabled: true | |
Lint/NonLocalExitFromIterator: | |
Description: 'Do not use return in iterator to cause non-local exit.' | |
Enabled: true | |
Lint/ParenthesesAsGroupedExpression: | |
Description: >- | |
Checks for method calls with a space before the opening | |
parenthesis. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces' | |
Enabled: true | |
Lint/RequireParentheses: | |
Description: >- | |
Use parentheses in the method call to avoid confusion | |
about precedence. | |
Enabled: true | |
Lint/RescueException: | |
Description: 'Avoid rescuing the Exception class.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-blind-rescues' | |
Enabled: true | |
Lint/ShadowingOuterLocalVariable: | |
Description: >- | |
Do not use the same name as outer local variable | |
for block arguments or block local variables. | |
Enabled: true | |
Lint/RedundantStringCoercion: | |
Description: 'Checks for Object#to_s usage in string interpolation.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-to-s' | |
Enabled: true | |
Lint/UnderscorePrefixedVariableName: | |
Description: 'Do not use prefix `_` for a variable that is used.' | |
Enabled: true | |
Lint/UnusedBlockArgument: | |
Description: 'Checks for unused block arguments.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars' | |
Enabled: true | |
Lint/UnusedMethodArgument: | |
Description: 'Checks for unused method arguments.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars' | |
Enabled: true | |
Lint/UnreachableCode: | |
Description: 'Unreachable code.' | |
Enabled: true | |
Lint/UselessAccessModifier: | |
Description: 'Checks for useless access modifiers.' | |
Enabled: true | |
Lint/UselessAssignment: | |
Description: 'Checks for useless assignment to a local variable.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars' | |
Enabled: true | |
Lint/BinaryOperatorWithIdenticalOperands: | |
Description: 'Checks for comparison of something with itself.' | |
Enabled: true | |
Lint/UselessElseWithoutRescue: | |
Description: 'Checks for useless `else` in `begin..end` without `rescue`.' | |
Enabled: true | |
Lint/UselessSetterCall: | |
Description: 'Checks for useless setter call to a local variable.' | |
Enabled: true | |
Lint/Void: | |
Description: 'Possible use of operator/literal/variable in void context.' | |
Enabled: true | |
Lint/SafeNavigationChain: | |
Enabled: true | |
Lint/SafeNavigationConsistency: | |
Enabled: true | |
Lint/ConstantDefinitionInBlock: | |
Enabled: true | |
Lint/DeprecatedOpenSSLConstant: | |
Enabled: true | |
Lint/DuplicateElsifCondition: | |
Enabled: true | |
Lint/DuplicateRequire: | |
Enabled: true | |
Lint/DuplicateRescueException: | |
Enabled: true | |
Lint/EmptyConditionalBody: | |
Enabled: true | |
Lint/EmptyFile: | |
Enabled: true | |
Lint/FloatComparison: | |
Enabled: false | |
Lint/IdentityComparison: | |
Enabled: true | |
Lint/MissingSuper: | |
Enabled: true | |
Lint/MixedRegexpCaptureTypes: | |
Enabled: true | |
Lint/OutOfRangeRegexpRef: | |
Enabled: true | |
Lint/RaiseException: | |
Enabled: true | |
Lint/SelfAssignment: | |
Enabled: true | |
Lint/StructNewOverride: | |
Enabled: true | |
Lint/TopLevelReturnWithArgument: | |
Enabled: true | |
Lint/TrailingCommaInAttributeDeclaration: | |
Enabled: true | |
Lint/UnreachableLoop: | |
Enabled: true | |
Lint/UselessMethodDefinition: | |
Enabled: true | |
Lint/UselessTimes: | |
Enabled: true | |
Lint/AmbiguousAssignment: | |
Enabled: true | |
Lint/DeprecatedConstants: | |
Enabled: true | |
Lint/DuplicateBranch: | |
Enabled: true | |
Lint/DuplicateRegexpCharacterClassElement: | |
Enabled: true | |
Lint/EmptyBlock: | |
Enabled: true | |
Exclude: | |
- 'spec/factories/*.rb' | |
- 'spec/helpers/*.rb' | |
Lint/EmptyClass: | |
Enabled: true | |
Lint/LambdaWithoutLiteralBlock: | |
Enabled: true | |
Lint/NoReturnInBeginEndBlocks: | |
Enabled: true | |
Lint/NumberedParameterAssignment: | |
Enabled: true | |
Lint/OrAssignmentToConstant: | |
Enabled: true | |
Lint/RedundantDirGlobSort: | |
Enabled: true | |
Lint/SymbolConversion: | |
Enabled: true | |
Lint/ToEnumArguments: | |
Enabled: true | |
Lint/TripleQuotes: | |
Enabled: true | |
Lint/UnexpectedBlockArity: | |
Enabled: true | |
Lint/UnmodifiedReduceAccumulator: | |
Enabled: true | |
Lint/AmbiguousRange: | |
Enabled: true | |
Lint/EmptyInPattern: | |
Enabled: true | |
Lint/AmbiguousOperatorPrecedence: | |
Enabled: true | |
Lint/ConstantOverwrittenInRescue: | |
Enabled: true | |
Lint/DuplicateMagicComment: | |
Enabled: true | |
Lint/IncompatibleIoSelectWithFiberScheduler: | |
Enabled: true | |
Lint/NonAtomicFileOperation: | |
Enabled: true | |
Lint/RefinementImportMethods: | |
Enabled: true | |
Lint/RequireRangeParentheses: | |
Enabled: true | |
Lint/RequireRelativeSelfPath: | |
Enabled: true | |
Lint/UselessRuby2Keywords: | |
Enabled: true | |
###################### Metrics #################################### | |
Metrics/AbcSize: | |
Description: >- | |
A calculated magnitude based on number of assignments, | |
branches, and conditions. | |
Reference: 'http://c2.com/cgi/wiki?AbcMetric' | |
Enabled: false | |
Max: 20 | |
Metrics/BlockNesting: | |
Description: 'Avoid excessive block nesting' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count' | |
Enabled: true | |
Max: 4 | |
Metrics/ClassLength: | |
Description: 'Avoid classes longer than 250 lines of code.' | |
Enabled: false | |
Max: 250 | |
Metrics/CyclomaticComplexity: | |
Description: >- | |
A complexity metric that is strongly correlated to the number | |
of test cases needed to validate a method. | |
Enabled: false | |
Max: 15 | |
Metrics/MethodLength: | |
Description: 'Avoid methods longer than 60 lines of code.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods' | |
Enabled: false | |
Max: 60 | |
Metrics/ModuleLength: | |
Description: 'Avoid modules longer than 250 lines of code.' | |
Enabled: true | |
Max: 250 | |
Metrics/ParameterLists: | |
Description: 'Avoid parameter lists longer than three or four parameters.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params' | |
Enabled: true | |
Metrics/PerceivedComplexity: | |
Description: >- | |
A complexity metric geared towards measuring complexity for a | |
human reader. | |
Enabled: false | |
Metrics/BlockLength: | |
Enabled: false | |
##################### Performance ############################# | |
Performance/Count: | |
Description: >- | |
Use `count` instead of `select...size`, `reject...size`, | |
`select...count`, `reject...count`, `select...length`, | |
and `reject...length`. | |
Enabled: true | |
Performance/Detect: | |
Description: >- | |
Use `detect` instead of `select.first`, `find_all.first`, | |
`select.last`, and `find_all.last`. | |
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code' | |
Enabled: true | |
Performance/FlatMap: | |
Description: >- | |
Use `Enumerable#flat_map` | |
instead of `Enumerable#map...Array#flatten(1)` | |
or `Enumberable#collect..Array#flatten(1)` | |
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablemaparrayflatten-vs-enumerableflat_map-code' | |
Enabled: true | |
EnabledForFlattenWithoutParams: false | |
# If enabled, this cop will warn about usages of | |
# `flatten` being called without any parameters. | |
# This can be dangerous since `flat_map` will only flatten 1 level, and | |
# `flatten` without any parameters can flatten multiple levels. | |
Performance/ReverseEach: | |
Description: 'Use `reverse_each` instead of `reverse.each`.' | |
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablereverseeach-vs-enumerablereverse_each-code' | |
Enabled: true | |
Performance/Size: | |
Description: >- | |
Use `size` instead of `count` for counting | |
the number of elements in `Array` and `Hash`. | |
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arraycount-vs-arraysize-code' | |
Enabled: true | |
Performance/StringReplacement: | |
Description: >- | |
Use `tr` instead of `gsub` when you are replacing the same | |
number of characters. Use `delete` instead of `gsub` when | |
you are deleting characters. | |
Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringgsub-vs-stringtr-code' | |
Enabled: true | |
Performance/StringInclude: | |
Description: 'Use String#include? instead of a regex match with literal-only pattern.' | |
Enabled: true | |
Performance/TimesMap: | |
Enabled: true | |
Performance/AncestorsInclude: | |
Enabled: true | |
Performance/BigDecimalWithNumericArgument: | |
Enabled: true | |
Performance/RedundantSortBlock: | |
Enabled: true | |
Performance/RedundantStringChars: | |
Enabled: true | |
Performance/ReverseFirst: | |
Enabled: true | |
Performance/SortReverse: | |
Enabled: true | |
Performance/Squeeze: | |
Enabled: true | |
Performance/Sum: | |
Enabled: true | |
Performance/BlockGivenWithExplicitBlock: | |
Enabled: true | |
Performance/CollectionLiteralInLoop: | |
Enabled: true | |
Performance/ConstantRegexp: | |
Enabled: true | |
Performance/MapCompact: | |
Enabled: true | |
Performance/MethodObjectAsBlock: | |
Enabled: true | |
Performance/RedundantEqualityComparisonBlock: | |
Enabled: true | |
Performance/RedundantSplitRegexpArgument: | |
Enabled: true | |
Performance/ConcurrentMonotonicTime: | |
Enabled: true | |
Performance/StringIdentifierArgument: | |
Enabled: true | |
################## Style ################################# | |
Style/Alias: | |
Description: 'Use alias_method instead of alias.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#alias-method' | |
Enabled: false | |
Style/Sample: | |
Description: >- | |
Use `sample` instead of `shuffle.first`, | |
`shuffle.last`, and `shuffle[Fixnum]`. | |
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code' | |
Enabled: true | |
Style/AndOr: | |
Description: 'Use &&/|| instead of and/or.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-and-or-or' | |
Enabled: false | |
Style/ArrayJoin: | |
Description: 'Use Array#join instead of Array#*.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#array-join' | |
Enabled: false | |
Style/AsciiComments: | |
Description: 'Use only ascii symbols in comments.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments' | |
Enabled: false | |
Style/Attr: | |
Description: 'Checks for uses of Module#attr.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr' | |
Enabled: false | |
Style/BeginBlock: | |
Description: 'Avoid the use of BEGIN blocks.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-BEGIN-blocks' | |
Enabled: true | |
Style/BarePercentLiterals: | |
Description: 'Checks if usage of %() or %Q() matches configuration.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-q-shorthand' | |
Enabled: true | |
Style/BlockComments: | |
Description: 'Do not use block comments.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-block-comments' | |
Enabled: false | |
Style/BlockDelimiters: | |
Description: >- | |
Avoid using {...} for multi-line blocks (multiline chaining is | |
always ugly). | |
Prefer {...} over do...end for single-line blocks. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks' | |
Exclude: | |
- 'spec/**/*' | |
Enabled: true | |
Style/CaseEquality: | |
Description: 'Avoid explicit use of the case equality operator(===).' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-case-equality' | |
Enabled: false | |
Style/CharacterLiteral: | |
Description: 'Checks for uses of character literals.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals' | |
Enabled: false | |
Style/ClassAndModuleChildren: | |
Description: 'Checks style of children classes and modules.' | |
Enabled: false | |
Style/ClassCheck: | |
Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.' | |
Enabled: true | |
Style/ClassMethods: | |
Description: 'Use self when defining module/class methods.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#def-self-class-methods' | |
Enabled: false | |
Style/ClassVars: | |
Description: 'Avoid the use of class variables.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-class-vars' | |
Enabled: false | |
Style/ColonMethodCall: | |
Description: 'Do not use :: for method call.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#double-colons' | |
Enabled: false | |
Style/CommandLiteral: | |
Description: 'Use `` or %x around command literals.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-x' | |
Enabled: false | |
Style/CommentAnnotation: | |
Description: 'Checks formatting of annotation comments.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#annotate-keywords' | |
Enabled: false | |
Style/DefWithParentheses: | |
Description: 'Use def with parentheses when there are arguments.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens' | |
Enabled: false | |
Style/PreferredHashMethods: | |
Description: 'Checks for use of deprecated Hash methods.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-key' | |
Enabled: false | |
Style/Documentation: | |
Description: 'Document classes and non-namespace modules.' | |
Enabled: false | |
Style/DoubleNegation: | |
Description: 'Checks for uses of double negation (!!).' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-bang-bang' | |
Enabled: true | |
Style/EachWithObject: | |
Description: 'Prefer `each_with_object` over `inject` or `reduce`.' | |
Enabled: true | |
Style/EmptyElse: | |
Description: 'Avoid empty else-clauses.' | |
Enabled: false | |
Style/EmptyLiteral: | |
Description: 'Prefer literals to Array.new/Hash.new/String.new.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#literal-array-hash' | |
Enabled: false | |
Style/EndBlock: | |
Description: 'Avoid the use of END blocks.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-END-blocks' | |
Enabled: false | |
Style/EvenOdd: | |
Description: 'Favor the use of Fixnum#even? && Fixnum#odd?' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods' | |
Enabled: false | |
Style/For: | |
Description: 'Checks use of for or each in multiline loops.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-for-loops' | |
Enabled: false | |
Style/FormatString: | |
Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#sprintf' | |
Enabled: false | |
Style/GlobalVars: | |
Description: 'Do not introduce global variables.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#instance-vars' | |
Reference: 'http://www.zenspider.com/Languages/Ruby/QuickRef.html' | |
Enabled: false | |
Style/GuardClause: | |
Description: 'Check for conditionals that can be replaced with guard clauses' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals' | |
Enabled: false | |
Style/HashSyntax: | |
Description: >- | |
Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax | |
{ :a => 1, :b => 2 }. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-literals' | |
Enabled: true | |
Style/IfUnlessModifier: | |
Description: >- | |
Favor modifier if/unless usage when you have a | |
single-line body. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier' | |
Enabled: false | |
Style/IfWithSemicolon: | |
Description: 'Do not use if x; .... Use the ternary operator instead.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs' | |
Enabled: true | |
Style/InfiniteLoop: | |
Description: 'Use Kernel#loop for infinite loops.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#infinite-loop' | |
Enabled: false | |
Style/Lambda: | |
Description: 'Use the new lambda literal syntax for single-line blocks.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#lambda-multi-line' | |
Enabled: true | |
Style/LambdaCall: | |
Description: 'Use lambda.call(...) instead of lambda.(...).' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc-call' | |
Enabled: false | |
Style/LineEndConcatenation: | |
Description: >- | |
Use \ instead of + or << to concatenate two string literals at | |
line end. | |
Enabled: false | |
Style/MethodCallWithoutArgsParentheses: | |
Description: 'Do not use parentheses for method calls with no arguments.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-args-no-parens' | |
Enabled: false | |
Style/MethodDefParentheses: | |
Description: >- | |
Checks if the method definitions have or don't have | |
parentheses. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens' | |
Enabled: false | |
Style/ModuleFunction: | |
Description: 'Checks for usage of `extend self` in modules.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#module-function' | |
Enabled: false | |
Style/MultilineBlockChain: | |
Description: 'Avoid multi-line chains of blocks.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks' | |
Enabled: false | |
Style/MultilineIfThen: | |
Description: 'Do not use then for multi-line if/unless.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-then' | |
Enabled: false | |
Style/MultilineTernaryOperator: | |
Description: >- | |
Avoid multi-line ?: (the ternary operator); | |
use if/unless instead. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-multiline-ternary' | |
Enabled: false | |
Style/NegatedIf: | |
Description: >- | |
Favor unless over if for negative conditions | |
(or control flow or). | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#unless-for-negatives' | |
Enabled: false | |
Style/NegatedWhile: | |
Description: 'Favor until over while for negative conditions.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#until-for-negatives' | |
Enabled: false | |
Style/NestedTernaryOperator: | |
Description: 'Use one expression per branch in a ternary operator.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-ternary' | |
Enabled: false | |
Style/Next: | |
Description: 'Use `next` to skip iteration instead of a condition at the end.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals' | |
Enabled: true | |
Style/NilComparison: | |
Description: 'Prefer x.nil? to x == nil.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods' | |
Enabled: true | |
Style/NonNilCheck: | |
Description: 'Checks for redundant nil checks.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-non-nil-checks' | |
Enabled: true | |
Style/Not: | |
Description: 'Use ! instead of not.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bang-not-not' | |
Enabled: false | |
Style/NumericLiterals: | |
Description: >- | |
Add underscores to large numeric literals to improve their | |
readability. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics' | |
Enabled: false | |
Style/OneLineConditional: | |
Description: >- | |
Favor the ternary operator(?:) over | |
if/then/else/end constructs. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator' | |
Enabled: false | |
Style/OptionalArguments: | |
Description: >- | |
Checks for optional arguments that do not appear at the end | |
of the argument list | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#optional-arguments' | |
Enabled: false | |
Style/ParallelAssignment: | |
Description: >- | |
Check for simple usages of parallel assignment. | |
It will only warn when the number of variables | |
matches on both sides of the assignment. | |
This also provides performance benefits | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parallel-assignment' | |
Enabled: false | |
Style/ParenthesesAroundCondition: | |
Description: >- | |
Don't use parentheses around the condition of an | |
if/unless/while. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-parens-if' | |
Enabled: false | |
Style/PercentLiteralDelimiters: | |
Description: 'Use `%`-literal delimiters consistently' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-literal-braces' | |
Enabled: false | |
Style/PercentQLiterals: | |
Description: 'Checks if uses of %Q/%q match the configured preference.' | |
Enabled: false | |
Style/PerlBackrefs: | |
Description: 'Avoid Perl-style regex back references.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers' | |
Enabled: false | |
Style/Proc: | |
Description: 'Use proc instead of Proc.new.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc' | |
Enabled: true | |
Style/RaiseArgs: | |
Description: 'Checks the arguments passed to raise/fail.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#exception-class-messages' | |
Enabled: false | |
Style/RedundantBegin: | |
Description: "Don't use begin blocks when they are not needed." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#begin-implicit' | |
Enabled: true | |
Style/RedundantException: | |
Description: "Checks for an obsolete RuntimeException argument in raise/fail." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-explicit-runtimeerror' | |
Enabled: true | |
Style/RedundantReturn: | |
Description: "Don't use return where it's not required." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-explicit-return' | |
Enabled: true | |
Style/RedundantSelf: | |
Description: "Don't use self where it's not needed." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-self-unless-required' | |
Enabled: true | |
Style/RegexpLiteral: | |
Description: 'Use / or %r around regular expressions.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r' | |
Enabled: false | |
Style/RescueModifier: | |
Description: 'Avoid using rescue in its modifier form.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-rescue-modifiers' | |
Enabled: false | |
Style/SelfAssignment: | |
Description: >- | |
Checks for places where self-assignment shorthand should have | |
been used. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#self-assignment' | |
Enabled: false | |
Style/Semicolon: | |
Description: "Don't use semicolons to terminate expressions." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon' | |
Enabled: false | |
Style/SignalException: | |
Description: 'Checks for proper usage of fail and raise.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#fail-method' | |
Enabled: false | |
Style/SingleLineBlockParams: | |
Description: 'Enforces the names of some block params.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#reduce-blocks' | |
Enabled: false | |
Style/SingleLineMethods: | |
Description: 'Avoid single-line methods.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-single-line-methods' | |
Enabled: false | |
Style/TrivialAccessors: | |
Description: 'Prefer attr_* methods to trivial readers/writers.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr_family' | |
Enabled: false | |
Style/UnlessElse: | |
Description: >- | |
Do not use unless with else. Rewrite these with the positive | |
case first. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-else-with-unless' | |
Enabled: true | |
Style/RedundantCapitalW: | |
Description: 'Checks for %W when interpolation is not needed.' | |
Enabled: true | |
Style/RedundantPercentQ: | |
Description: 'Checks for %q/%Q when single quotes or double quotes would do.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-q' | |
Enabled: true | |
Style/TrailingUnderscoreVariable: | |
Description: >- | |
Checks for the usage of unneeded trailing underscores at the | |
end of parallel variable assignment. | |
Enabled: false | |
Style/VariableInterpolation: | |
Description: >- | |
Don't interpolate global, instance and class variables | |
directly in strings. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#curlies-interpolate' | |
Enabled: false | |
Style/WhenThen: | |
Description: 'Use when x then ... for one-line cases.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#one-line-cases' | |
Enabled: false | |
Style/WhileUntilDo: | |
Description: 'Checks for redundant do after while or until.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-multiline-while-do' | |
Enabled: false | |
Style/WhileUntilModifier: | |
Description: >- | |
Favor modifier while/until usage when you have a | |
single-line body. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier' | |
Enabled: false | |
Style/WordArray: | |
Description: 'Use %w or %W for arrays of words.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w' | |
Enabled: false | |
Style/TrailingCommaInArguments: | |
Description: 'Checks for trailing comma in parameter lists.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma' | |
Enabled: false | |
Style/SpecialGlobalVars: | |
Description: 'Avoid Perl-style global variables.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms' | |
Enabled: false | |
Style/StringLiterals: | |
Description: 'Checks if uses of quotes match the configured preference.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals' | |
Enabled: false | |
Style/StringLiteralsInInterpolation: | |
Description: >- | |
Checks if uses of quotes inside expressions in interpolated | |
strings match the configured preference. | |
Enabled: false | |
Style/FrozenStringLiteralComment: | |
Description: 'It will add or remove the comment `# frozen_string_literal: true` to the top of files to enable frozen string literals.' | |
Enabled: true | |
EnforcedStyle: never | |
Style/StructInheritance: | |
Description: 'Checks for inheritance from Struct.new.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new' | |
Enabled: false | |
Style/SymbolLiteral: | |
Description: 'Use plain symbols instead of string symbols when possible.' | |
Enabled: false | |
Style/SymbolProc: | |
Description: 'Use symbols as procs instead of blocks when possible.' | |
Enabled: false | |
Style/MultipleComparison: | |
Description: 'Avoid comparing a variable with multiple items in a conditional, use Array#include? instead.' | |
Enabled: true | |
Style/FloatDivision: | |
Description: 'Prefer using .to_f on one side only.' | |
Enabled: false | |
Style/MixinUsage: | |
Enabled: true | |
Style/FormatStringToken: | |
Enabled: false | |
Style/AccessorGrouping: | |
Enabled: true | |
Style/BisectedAttrAccessor: | |
Enabled: true | |
Style/CaseLikeIf: | |
Enabled: true | |
Style/CombinableLoops: | |
Enabled: true | |
Style/ExplicitBlockArgument: | |
Enabled: true | |
Style/ExponentialNotation: | |
Enabled: true | |
Style/GlobalStdStream: | |
Enabled: true | |
Style/HashAsLastArrayItem: | |
Enabled: true | |
Style/HashEachMethods: | |
Enabled: true | |
Style/HashLikeCase: | |
Enabled: true | |
Style/HashTransformKeys: | |
Enabled: true | |
Style/HashTransformValues: | |
Enabled: true | |
Style/KeywordParametersOrder: | |
Enabled: true | |
Style/CommentedKeyword: | |
Enabled: true | |
Style/OptionalBooleanParameter: | |
Enabled: false | |
Style/RedundantAssignment: | |
Enabled: true | |
Style/RedundantFetchBlock: | |
Enabled: true | |
Style/RedundantFileExtensionInRequire: | |
Enabled: true | |
Style/RedundantRegexpCharacterClass: | |
Enabled: true | |
Style/RedundantRegexpEscape: | |
Enabled: true | |
Style/RedundantSelfAssignment: | |
Enabled: true | |
Style/SingleArgumentDig: | |
Enabled: true | |
Style/SlicingWithRange: | |
Enabled: true | |
Style/SoleNestedConditional: | |
Enabled: true | |
Style/StringConcatenation: | |
Enabled: true | |
Style/ArgumentsForwarding: | |
Enabled: true | |
Style/CollectionCompact: | |
Enabled: true | |
Style/DocumentDynamicEvalDefinition: | |
Enabled: true | |
Style/EndlessMethod: | |
Enabled: true | |
Style/HashConversion: | |
Enabled: true | |
Style/HashExcept: | |
Enabled: true | |
Style/IfWithBooleanLiteralBranches: | |
Description: 'Remove redundant ternary operator with boolean literal branches.' | |
Enabled: true | |
Style/NegatedIfElseCondition: | |
Description: 'Invert the negated condition and swap the ternary branches.' | |
Enabled: true | |
Style/NilLambda: | |
Enabled: true | |
Style/RedundantArgument: | |
Enabled: true | |
Style/StringChars: | |
Description: 'Use chars instead of split("")' | |
Enabled: true | |
Style/SwapValues: | |
Enabled: true | |
Style/InPatternThen: | |
Enabled: true | |
Style/MultilineInPatternThen: | |
Enabled: true | |
Style/QuotedSymbols: | |
Enabled: true | |
Style/RedundantSelfAssignmentBranch: | |
Enabled: true | |
Style/EmptyHeredoc: | |
Enabled: true | |
Style/EnvHome: | |
Enabled: true | |
Style/FetchEnvVar: | |
Enabled: true | |
Style/FileRead: | |
Enabled: true | |
Style/FileWrite: | |
Enabled: true | |
Style/MagicCommentFormat: | |
Enabled: true | |
Style/MapCompactWithConditionalBlock: | |
Enabled: true | |
Style/MapToHash: | |
Enabled: true | |
Style/NestedFileDirname: | |
Enabled: true | |
Style/NumberedParameters: | |
Enabled: true | |
Style/NumberedParametersLimit: | |
Enabled: true | |
Style/ObjectThen: | |
Enabled: true | |
Style/OpenStructUse: | |
Enabled: true | |
Style/OperatorMethodCall: | |
Enabled: true | |
Style/RedundantInitialize: | |
Enabled: true | |
Style/RedundantStringEscape: | |
Enabled: true | |
Style/SelectByRegexp: | |
Enabled: true | |
Style/RedundantEach: | |
Enabled: true | |
################## Layout ################################# | |
Layout/SpaceBeforeFirstArg: | |
Description: >- | |
Checks that exactly one space is used between a method name | |
and the first argument for method calls without parentheses. | |
Enabled: true | |
Layout/SpaceAfterColon: | |
Description: 'Use spaces after colons.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators' | |
Enabled: false | |
Layout/SpaceAfterComma: | |
Description: 'Use spaces after commas.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators' | |
Enabled: false | |
Layout/SpaceAroundKeyword: | |
Description: 'Use spaces around keywords.' | |
Enabled: false | |
Layout/SpaceAfterMethodName: | |
Description: >- | |
Do not put a space between a method name and the opening | |
parenthesis in a method definition. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces' | |
Enabled: true | |
Layout/SpaceAfterNot: | |
Description: Tracks redundant space after the ! operator. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-space-bang' | |
Enabled: true | |
Layout/SpaceAfterSemicolon: | |
Description: 'Use spaces after semicolons.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators' | |
Enabled: false | |
Layout/SpaceBeforeBlockBraces: | |
Description: >- | |
Checks that the left block brace has or doesn't have space | |
before it. | |
Enabled: true | |
EnforcedStyle: space | |
Layout/SpaceBeforeComma: | |
Description: 'No spaces before commas.' | |
Enabled: true | |
Layout/SpaceBeforeComment: | |
Description: >- | |
Checks for missing space between code and a comment on the | |
same line. | |
Enabled: false | |
Layout/SpaceBeforeSemicolon: | |
Description: 'No spaces before semicolons.' | |
Enabled: false | |
Layout/SpaceInsideBlockBraces: | |
Description: >- | |
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. | |
Enabled: false | |
Layout/SpaceAroundBlockParameters: | |
Description: 'Checks the spacing inside and after block parameters pipes.' | |
Enabled: false | |
Layout/SpaceAroundEqualsInParameterDefault: | |
Description: >- | |
Checks that the equals signs in parameter default assignments | |
have or don't have surrounding space depending on | |
configuration. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-around-equals' | |
Enabled: false | |
Layout/SpaceAroundOperators: | |
Description: 'Use a single space around operators.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators' | |
Enabled: false | |
Layout/SpaceInsideHashLiteralBraces: | |
Description: "Use spaces inside hash literal braces - or don't." | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators' | |
Enabled: false | |
Layout/SpaceInsideParens: | |
Description: 'No spaces after ( or before ).' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-spaces-braces' | |
Enabled: true | |
Layout/SpaceInsideRangeLiteral: | |
Description: 'No spaces inside range literals.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-space-inside-range-literals' | |
Enabled: false | |
Layout/SpaceInsideStringInterpolation: | |
Description: 'Checks for padding/surrounding spaces inside string interpolation.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#string-interpolation' | |
Enabled: false | |
Layout/SpaceInLambdaLiteral: | |
Description: 'Use a space between `->` and `(` in lambda literals.' | |
EnforcedStyle: 'require_space' | |
Enabled: true | |
Layout/IndentationStyle: | |
Description: 'No hard tabs.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation' | |
Enabled: false | |
Layout/TrailingEmptyLines: | |
Description: 'Checks trailing blank lines and final newline.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#newline-eof' | |
Enabled: false | |
Layout/TrailingWhitespace: | |
Description: 'Avoid trailing whitespace.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace' | |
Enabled: true | |
Layout/AccessModifierIndentation: | |
Description: Check indentation of private/protected visibility modifiers. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#indent-public-private-protected' | |
Enabled: false | |
Layout/MultilineHashBraceLayout: | |
EnforcedStyle: 'new_line' | |
Enabled: true | |
Layout/BlockAlignment: | |
Description: 'Align block ends correctly.' | |
Enabled: true | |
Layout/ConditionPosition: | |
Description: >- | |
Checks for condition placed in a confusing position relative to | |
the keyword. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition' | |
Enabled: true | |
Layout/DefEndAlignment: | |
Description: 'Align ends corresponding to defs correctly.' | |
Enabled: true | |
Layout/EndAlignment: | |
Description: 'Align ends correctly.' | |
Enabled: true | |
Layout/LineLength: | |
Description: 'Limit lines to 80 characters.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits' | |
Enabled: false | |
Layout/ArrayAlignment: | |
Description: >- | |
Align the elements of an array literal if they span more than | |
one line. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#align-multiline-arrays' | |
Enabled: true | |
Layout/HashAlignment: | |
Description: >- | |
Align the elements of a hash literal if they span more than | |
one line. | |
Enabled: false | |
Layout/ParameterAlignment: | |
Description: >- | |
Align the parameters of a method call if they span more | |
than one line. | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent' | |
Enabled: true | |
Layout/BlockEndNewline: | |
Description: 'Put end statement of multiline block on its own line.' | |
Enabled: false | |
Layout/CaseIndentation: | |
Description: 'Indentation of when in a case/when/[else/]end.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#indent-when-to-case' | |
Enabled: true | |
Layout/ClosingParenthesisIndentation: | |
Description: 'Checks the indentation of hanging closing parentheses.' | |
Enabled: true | |
Layout/CommentIndentation: | |
Description: 'Indentation of comments.' | |
Enabled: false | |
Layout/DotPosition: | |
Description: 'Checks the position of the dot in multi-line method calls.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains' | |
Enabled: false | |
Layout/ElseAlignment: | |
Description: 'Align elses and elsifs correctly.' | |
Enabled: true | |
Layout/EmptyLineBetweenDefs: | |
Description: 'Use empty lines between defs.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods' | |
Enabled: false | |
Layout/EmptyLines: | |
Description: "Don't use several empty lines in a row." | |
Enabled: true | |
Layout/EmptyLinesAroundAccessModifier: | |
Description: "Keep blank lines around access modifiers." | |
Enabled: false | |
Layout/EmptyLinesAroundBlockBody: | |
Description: "Keeps track of empty lines around block bodies." | |
Enabled: false | |
Layout/EmptyLinesAroundClassBody: | |
Description: "Keeps track of empty lines around class bodies." | |
Enabled: false | |
Layout/EmptyLinesAroundModuleBody: | |
Description: "Keeps track of empty lines around module bodies." | |
Enabled: false | |
Layout/EmptyLinesAroundMethodBody: | |
Description: "Keeps track of empty lines around method bodies." | |
Enabled: false | |
Layout/RescueEnsureAlignment: | |
Description: 'Align rescues and ensures correctly.' | |
Enabled: false | |
Layout/EndOfLine: | |
Description: 'Use Unix-style line endings.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#crlf' | |
Enabled: false | |
Layout/ExtraSpacing: | |
Description: 'Do not use unnecessary spacing.' | |
Enabled: false | |
Layout/InitialIndentation: | |
Description: >- | |
Checks the indentation of the first non-blank non-comment line in a file. | |
Enabled: false | |
Layout/FirstParameterIndentation: | |
Description: 'Checks the indentation of the first parameter in a method call.' | |
Enabled: false | |
Layout/IndentationConsistency: | |
Description: 'Keep indentation straight.' | |
Enabled: false | |
Layout/IndentationWidth: | |
Description: 'Use 2 spaces for indentation.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation' | |
Enabled: true | |
Layout/FirstArrayElementIndentation: | |
Description: >- | |
Checks the indentation of the first element in an array | |
literal. | |
Enabled: false | |
Layout/FirstHashElementIndentation: | |
Description: 'Checks the indentation of the first key in a hash literal.' | |
Enabled: false | |
Layout/LeadingCommentSpace: | |
Description: 'Comments should start with a space.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-space' | |
Enabled: false | |
Layout/MultilineBlockLayout: | |
Description: 'Ensures newlines after multiline block do statements.' | |
Enabled: false | |
Layout/MultilineOperationIndentation: | |
Description: >- | |
Checks indentation of binary operations that span more than | |
one line. | |
Enabled: false | |
Layout/SpaceBeforeBrackets: | |
Enabled: true | |
Layout/BeginEndAlignment: | |
Enabled: true | |
Layout/EmptyLinesAroundAttributeAccessor: | |
Enabled: true | |
Layout/SpaceAroundMethodCallOperator: | |
Enabled: true | |
Layout/LineEndStringConcatenationIndentation: | |
Enabled: true | |
Layout/LineContinuationLeadingSpace: | |
Enabled: true | |
Layout/LineContinuationSpacing: | |
Enabled: true | |
################## Naming ################################# | |
Naming/AccessorMethodName: | |
Description: Check the naming of accessor methods for get_/set_. | |
Enabled: false | |
Naming/PredicateName: | |
Description: 'Check the names of predicate methods.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark' | |
Enabled: false | |
Naming/VariableName: | |
Description: 'Use the configured style when naming variables.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars' | |
Enabled: false | |
Naming/FileName: | |
Description: 'Use snake_case for source file names.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files' | |
Enabled: false | |
Naming/AsciiIdentifiers: | |
Description: 'Use only ascii symbols in identifiers.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-identifiers' | |
Enabled: false | |
Naming/ClassAndModuleCamelCase: | |
Description: 'Use CamelCase for classes and modules.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#camelcase-classes' | |
Enabled: false | |
Naming/ConstantName: | |
Description: 'Constants should use SCREAMING_SNAKE_CASE.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#screaming-snake-case' | |
Enabled: true | |
Naming/MethodName: | |
Description: 'Use the configured style when naming methods.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars' | |
Enabled: false | |
Naming/BinaryOperatorParameterName: | |
Description: 'When defining binary operators, name the argument other.' | |
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#other-arg' | |
Enabled: false | |
Naming/VariableNumber: | |
Description: 'Use snake_case for symbol numbers.' | |
Enabled: false | |
EnforcedStyle: 'snake_case' | |
Naming/InclusiveLanguage: | |
Enabled: true | |
Naming/BlockForwarding: | |
Enabled: true | |
################### Security ################################# | |
Security/CompoundHash: | |
Enabled: true | |
Security/IoMethods: | |
Description: 'Checks for the first argument to IO.read, IO.binread, IO.write, IO.binwrite, IO.foreach, and IO.readlines.' | |
Enabled: true | |
Security/Eval: | |
Description: 'Checks for the use of Kernel#eval and Binding#eval.' | |
Enabled: true | |
Security/JSONLoad: | |
Description: 'Checks for the use of JSON class methods which have potential security issues.' | |
Enabled: true | |
Security/MarshalLoad: | |
Description: >- | |
Checks for the use of Marshal class methods which have potential security issues | |
leading to remote code execution when loading from an untrusted source. | |
Enabled: true | |
Security/YAMLLoad: | |
Description: >- | |
Checks for the use of YAML class methods which have potential security issues | |
leading to remote code execution when loading from an untrusted source. | |
Enabled: true | |
Security/Open: | |
Description: 'Checks for the use of Kernel#open and URI.open with dynamic data.' | |
Enabled: true | |
##################### Rails ################################## | |
Rails: | |
Enabled: true | |
Rails/ActionFilter: | |
Description: 'Enforces consistent use of action filter methods.' | |
Enabled: false | |
Rails/Date: | |
Description: >- | |
Checks the correct usage of date aware methods, | |
such as Date.today, Date.current etc. | |
Enabled: true | |
Rails/Delegate: | |
Description: 'Prefer delegate method for delegations.' | |
Enabled: false | |
Rails/FindBy: | |
Description: 'Prefer find_by over where.first.' | |
Enabled: true | |
Rails/FindEach: | |
Description: 'Prefer all.find_each over all.find.' | |
Enabled: true | |
Rails/HasAndBelongsToMany: | |
Description: 'Prefer has_many :through to has_and_belongs_to_many.' | |
Enabled: false | |
Rails/Output: | |
Description: 'Checks for calls to puts, print, etc.' | |
Enabled: false | |
Rails/ReadWriteAttribute: | |
Description: >- | |
Checks for read_attribute(:attr) and | |
write_attribute(:attr, val). | |
Enabled: false | |
Rails/ScopeArgs: | |
Description: 'Checks the arguments of ActiveRecord scopes.' | |
Enabled: false | |
Rails/TimeZone: | |
Description: 'Checks the correct usage of time zone aware methods.' | |
StyleGuide: 'https://github.com/bbatsov/rails-style-guide#time' | |
Reference: 'http://danilenko.org/2012/7/6/rails_timezones' | |
Enabled: true | |
Rails/Blank: | |
Enabled: true | |
Rails/Validation: | |
Description: 'Use validates :attribute, hash of validations.' | |
Enabled: false | |
Rails/UniqueValidationWithoutIndex: | |
Description: 'Uniqueness validation should be with a unique index.' | |
Enabled: false | |
Rails/OutputSafety: | |
Description: 'Tagging a string as html safe may be a security risk.' | |
Enabled: false | |
Rails/AttributeDefaultBlockValue: | |
Enabled: true | |
Rails/EnvironmentVariableAccess: | |
Enabled: true | |
AllowReads: true | |
Rails/TimeZoneAssignment: | |
Enabled: true | |
Rails/WhereEquals: | |
Enabled: true | |
Rails/SafeNavigation: | |
Enabled: true | |
ConvertTry: true | |
Rails/SafeNavigationWithBlank: | |
Enabled: true | |
Rails/RedundantForeignKey: | |
Enabled: false | |
Rails/InverseOf: | |
Enabled: false | |
Rails/HasManyOrHasOneDependent: | |
Enabled: false | |
Rails/ActiveRecordCallbacksOrder: | |
Enabled: true | |
Rails/AfterCommitOverride: | |
Enabled: true | |
Rails/FindById: | |
Enabled: true | |
Rails/Inquiry: | |
Enabled: true | |
Rails/MailerName: | |
Enabled: true | |
Rails/MatchRoute: | |
Enabled: true | |
Rails/NegateInclude: | |
Enabled: true | |
Rails/Pluck: | |
Enabled: true | |
Rails/PluckInWhere: | |
Enabled: true | |
Rails/RenderInline: | |
Enabled: true | |
Rails/RenderPlainText: | |
Enabled: true | |
Rails/ShortI18n: | |
Enabled: true | |
Rails/SquishedSQLHeredocs: | |
Enabled: true | |
Rails/WhereExists: | |
Enabled: true | |
Rails/WhereNot: | |
Enabled: true | |
Rails/AddColumnIndex: | |
Enabled: true | |
Rails/EagerEvaluationLogMessage: | |
Enabled: true | |
Rails/ExpandedDateRange: | |
Enabled: true | |
Rails/I18nLocaleAssignment: | |
Enabled: true | |
Rails/UnusedIgnoredColumns: | |
Enabled: true | |
Rails/ActionControllerFlashBeforeRender: | |
Enabled: true | |
Rails/ActionControllerTestCase: | |
Enabled: true | |
Rails/ActionOrder: | |
Enabled: true | |
Rails/ActiveSupportOnLoad: | |
Enabled: true | |
Rails/CompactBlank: | |
Enabled: true | |
Rails/DeprecatedActiveModelErrorsMethods: | |
Enabled: true | |
Rails/DotSeparatedKeys: | |
Enabled: true | |
Rails/DuplicateAssociation: | |
Enabled: true | |
Rails/DuplicateScope: | |
Enabled: true | |
Rails/DurationArithmetic: | |
Enabled: true | |
Rails/FreezeTime: | |
Enabled: true | |
Rails/I18nLazyLookup: | |
Enabled: true | |
Rails/I18nLocaleTexts: | |
Enabled: true | |
Rails/IgnoredColumnsAssignment: | |
Enabled: true | |
Rails/MigrationClassName: | |
Enabled: true | |
Rails/RedundantPresenceValidationOnBelongsTo: | |
Enabled: true | |
Rails/RedundantTravelBack: | |
Enabled: true | |
Rails/RootJoinChain: | |
Enabled: true | |
Rails/RootPathnameMethods: | |
Enabled: true | |
Rails/RootPublicPath: | |
Enabled: true | |
Rails/StripHeredoc: | |
Enabled: true | |
Rails/ToFormattedS: | |
Enabled: true | |
Rails/ToSWithArgument: | |
Enabled: true | |
Rails/TopLevelHashWithIndifferentAccess: | |
Enabled: true | |
Rails/TransactionExitStatement: | |
Enabled: true | |
Rails/WhereMissing: | |
Enabled: true | |
Rails/WhereNotWithMultipleConditions: | |
Enabled: true | |
################## RSpec ################################# | |
RSpec: | |
Enabled: true | |
RSpec/FilePath: | |
Enabled: true | |
RSpec/NestedGroups: | |
Enabled: false | |
Max: 3 | |
RSpec/MultipleMemoizedHelpers: | |
Enabled: false | |
RSpec/MultipleExpectations: | |
Enabled: false | |
RSpec/ExampleLength: | |
Enabled: false | |
RSpec/InstanceVariable: | |
Enabled: false | |
RSpec/EmptyExampleGroup: | |
Enabled: false | |
RSpec/ExpectInHook: | |
Enabled: false | |
RSpec/AnyInstance: | |
Enabled: false | |
RSpec/ContextWording: | |
Enabled: true | |
Exclude: | |
- 'spec/controllers/**/*_spec.rb' | |
- 'spec/models/*.rb' | |
RSpec/StubbedMock: | |
Description: 'Prefer allow_any_instance_of over expect_any_instance_of when configuring a response.' | |
Enabled: true | |
RSpec/LetSetup: | |
Enabled: false | |
RSpec/IdenticalEqualityAssertion: | |
Enabled: true | |
RSpec/Rails/AvoidSetupHook: | |
Enabled: true | |
RSpec/BeEq: | |
Enabled: true | |
RSpec/BeNil: | |
Enabled: true | |
RSpec/ChangeByZero: | |
Enabled: true | |
RSpec/ClassCheck: | |
Enabled: true | |
RSpec/ExcessiveDocstringSpacing: | |
Enabled: true | |
RSpec/NoExpectationExample: | |
Enabled: true | |
RSpec/SortMetadata: | |
Enabled: true | |
RSpec/SubjectDeclaration: | |
Enabled: true | |
RSpec/VerifiedDoubleReference: | |
Enabled: true | |
RSpec/Capybara/NegationMatcher: | |
Enabled: true | |
RSpec/Capybara/SpecificActions: | |
Enabled: true | |
RSpec/Capybara/SpecificFinders: | |
Enabled: true | |
RSpec/Capybara/SpecificMatcher: | |
Enabled: true | |
RSpec/FactoryBot/ConsistentParenthesesStyle: | |
Enabled: true | |
RSpec/FactoryBot/SyntaxMethods: | |
Enabled: true | |
RSpec/Rails/HaveHttpStatus: | |
Enabled: true | |
RSpec/Rails/InferredSpecType: | |
Enabled: true | |
################## Bundler ################################# | |
Bundler: | |
Enabled: true | |
Bundler/DuplicatedGem: | |
Enabled: true | |
Bundler/GemFilename: | |
Enabled: true | |
Bundler/GemVersion: | |
Description: 'Enforce that Gem version specifications or a commit reference (branch, ref, or tag) are either required or forbidden.' | |
Enabled: false | |
Bundler/InsecureProtocolSource: | |
Enabled: true | |
Bundler/OrderedGems: | |
Description: 'Gems should be alphabetically sorted within groups.' | |
Enabled: true | |
################## Gemspec ################################# | |
Gemspec: | |
Enabled: false |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment