`.rubocop_todo.yml`: Enabling and todo-disabling an offence at the same time #13492

stdedos · 2024-11-25T14:41:53Z

stdedos
Nov 25, 2024

I have the following .rubocop.yml:

.rubocop.yml

inherit_from: .rubocop_todo.yml
inherit_mode:
  merge:
    - Exclude

require:
  - rubocop-performance
  # Cannot scope to `b/*`
  # https://github.com/rubocop/rubocop/discussions/13306
  # - rubocop-rails

AllCops:
  ActiveSupportExtensionsEnabled: true
  NewCops: enable
  TargetRubyVersion: 3.1
  # https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106868/diffs#057477721d04f350346ebfb6554f5c0cd2d8aeaf
  MaxFilesInCache: 250_000
  Exclude:
    - 'b/c/**/*'

Style/GlobalVars:
  AllowedVariables:
    - $ui_config

Style/StringLiterals:
  ConsistentQuotesInMultiline: true

Style/StringConcatenation:
  Mode: conservative

Lint/EmptyBlock:
  AllowComments: true

Style/UnlessLogicalOperators:
  EnforcedStyle: forbid_logical_operators

Style/RescueStandardError:
  EnforcedStyle: implicit

Style/InvertibleUnlessCondition:
  Enabled: true

# We often need to override Java getter names
Naming/AccessorMethodName:
  Enabled: false

# It "cannot be enabled" because "reasons":
Style/EachWithObject:
  Enabled: false

# XXX: To be enabled as soon as the big bang is done.
Style/RescueModifier:
  Enabled: false

# Disabling because of build issues. See:
# * https://github.com/rubocop/rubocop/discussions/13294
# * https://github.com/rubocop/rubocop/issues/13299
Style/BlockDelimiters:
  Enabled: false
  # # The only working style is:
  # EnforcedStyle: semantic
  # AllowBracesOnProceduralOneLiners: true

# Minimize git-diff changes, by trying to mimic black:
# https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#how-black-wraps-lines
Layout/MultilineArrayBraceLayout:
  EnforcedStyle: symmetrical

Layout/MultilineArrayLineBreaks:
  Enabled: true

Layout/FirstArrayElementLineBreak:
  Enabled: true

Layout/FirstArrayElementIndentation:
  EnforcedStyle: consistent

Style/TrailingCommaInArrayLiteral:
  EnforcedStyleForMultiline: consistent_comma

Layout/FirstHashElementLineBreak:
  Enabled: true

Layout/MultilineHashKeyLineBreaks:
  Enabled: true

Style/TrailingCommaInHashLiteral:
  EnforcedStyleForMultiline: consistent_comma

Layout/FirstMethodArgumentLineBreak:
  Enabled: true

Layout/MultilineMethodArgumentLineBreaks:
  Enabled: true

Layout/ArgumentAlignment:
  EnforcedStyle: with_first_argument

Style/TrailingCommaInArguments:
  EnforcedStyleForMultiline: consistent_comma

# Disabling all metrics for now
Metrics/AbcSize:
  Enabled: false

Metrics/BlockLength:
  Enabled: false

Metrics/BlockNesting:
  Enabled: false

Metrics/ClassLength:
  Enabled: false

Metrics/CollectionLiteralLength:
  Enabled: false

Metrics/CyclomaticComplexity:
  Enabled: false

Metrics/MethodLength:
  Enabled: false

Metrics/ModuleLength:
  Enabled: false

Metrics/ParameterLists:
  Enabled: false

Metrics/PerceivedComplexity:
  Enabled: false

and auto-generated* .rubocop_todo.yml:

.rubocop_todo.yml

# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2024-11-25 13:50:29 UTC using RuboCop version 1.68.0.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyleAlignWith.
# SupportedStylesAlignWith: either, start_of_block, start_of_line
Layout/BlockAlignment:
  Exclude:
    - '1.rb'
    - '2.rb'
    - '3.rb'

# Offense count: 12056
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
# URISchemes: http, https
Layout/LineLength:
  Max: 9388

# Offense count: 5
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: RequireParenthesesForMethodChains.
Lint/AmbiguousRange:
  Exclude:
    - '4.rb'
    - '5.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowSafeAssignment.
Lint/AssignmentInCondition:
  Exclude:
    - '6.rb'

# Offense count: 76
Lint/BinaryOperatorWithIdenticalOperands:
  Enabled: false

# Offense count: 3
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/BooleanSymbol:
  Exclude:
    - '7.rb'
    - '8.rb'

# Offense count: 27
# Configuration parameters: AllowedMethods.
# AllowedMethods: enums
Lint/ConstantDefinitionInBlock:
  Exclude:
    - '9.rb'
    - '10.rb'
    - '11.rb'
    - '12.rb'
    - '13.rb'
    - '14.rb'
    - '15.rb'
    - '16.rb'
    - '17.rb'
    - '18.rb'
    - '19.rb'
    - '20.rb'
    - '21.rb'
    - '22.rb'
    - '23.rb'

# Offense count: 17
# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
Lint/DuplicateBranch:
  Exclude:
    - '24.rb'
    - '25.rb'
    - '26.rb'
    - '27.rb'
    - '28.rb'
    - '29.rb'
    - '30.rb'
    - '31.rb'
    - '32.rb'
    - '33.rb'

# Offense count: 3
Lint/DuplicateHashKey:
  Exclude:
    - '34.rb'

# Offense count: 7
Lint/DuplicateMethods:
  Exclude:
    - '35.rb'
    - '36.rb'
    - '37.rb'
    - '38.rb'
    - '39.rb'

# Offense count: 6
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/DuplicateRequire:
  Exclude:
    - '40.rb'
    - '41.rb'
    - '42.rb'
    - '43.rb'
    - '44.rb'
    - '45.rb'

# Offense count: 159
# Configuration parameters: AllowComments, AllowEmptyLambdas.
Lint/EmptyBlock:
  Enabled: false

# Offense count: 11
# Configuration parameters: AllowComments.
Lint/EmptyClass:
  Exclude:
    - '46.rb'
    - '47.rb'
    - '48.rb'
    - '49.rb'
    - '50.rb'
    - '51.rb'
    - '52.rb'
    - '53.rb'
    - '54.rb'
    - '55.rb'
    - '56.rb'

# Offense count: 5
Lint/FloatComparison:
  Exclude:
    - '57.rb'
    - '58.rb'
    - '59.rb'
    - '60.rb'

# Offense count: 47
Lint/IneffectiveAccessModifier:
  Enabled: false

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: standard_error, runtime_error
Lint/InheritException:
  Exclude:
    - '61.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/InterpolationCheck:
  Exclude:
    - '62.rb'

# Offense count: 1
Lint/LiteralAsCondition:
  Exclude:
    - '63.rb'

# Offense count: 7
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/Loop:
  Exclude:
    - '64.rb'
    - '65.rb'
    - '66.rb'
    - '67.rb'
    - '68.rb'

# Offense count: 14
# Configuration parameters: AllowedParentClasses.
Lint/MissingSuper:
  Exclude:
    - '69.rb'
    - '70.rb'
    - '71.rb'
    - '72.rb'
    - '73.rb'
    - '74.rb'
    - '75.rb'

# Offense count: 3
# Configuration parameters: AllowedMethods, AllowedPatterns.
Lint/NestedMethodDefinition:
  Exclude:
    - '76.rb'
    - '77.rb'
    - '78.rb'

# Offense count: 1
Lint/NextWithoutAccumulator:
  Exclude:
    - '79.rb'

# Offense count: 1
Lint/NoReturnInBeginEndBlocks:
  Exclude:
    - '80.rb'

# Offense count: 187
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/NonAtomicFileOperation:
  Enabled: false

# Offense count: 2
Lint/NonLocalExitFromIterator:
  Exclude:
    - '81.rb'
    - '82.rb'

# Offense count: 5
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/OrAssignmentToConstant:
  Exclude:
    - '83.rb'
    - '84.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/PercentStringArray:
  Exclude:
    - '85.rb'

# Offense count: 2
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowedImplicitNamespaces.
# AllowedImplicitNamespaces: Gem
Lint/RaiseException:
  Exclude:
    - '86.rb'
    - '87.rb'

# Offense count: 1
Lint/RandOne:
  Exclude:
    - '88.rb'

# Offense count: 16
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/RedundantDirGlobSort:
  Exclude:
    - '89.rb'
    - '90.rb'

# Offense count: 5
# This cop supports unsafe autocorrection (--autocorrect-all).
Lint/RedundantRequireStatement:
  Exclude:
    - '91.rb'
    - '92.rb'
    - '93.rb'
    - '94.rb'
    - '95.rb'

# Offense count: 3
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowedMethods.
# AllowedMethods: instance_of?, kind_of?, is_a?, eql?, respond_to?, equal?
Lint/RedundantSafeNavigation:
  Exclude:
    - '96.rb'
    - '97.rb'
    - '98.rb'

# Offense count: 1
Lint/RequireParentheses:
  Exclude:
    - '99.rb'

# Offense count: 54
Lint/RescueException:
  Enabled: false

# Offense count: 1
Lint/SelfAssignment:
  Exclude:
    - '100.rb'

# Offense count: 4
# Configuration parameters: IgnoreImplicitReferences.
Lint/ShadowedArgument:
  Exclude:
    - '101.rb'
    - '102.rb'
    - '103.rb'

# Offense count: 4
Lint/ShadowedException:
  Exclude:
    - '104.rb'
    - '105.rb'
    - '106.rb'
    - '107.rb'

# Offense count: 550
Lint/ShadowingOuterLocalVariable:
  Enabled: false

# Offense count: 1
Lint/StructNewOverride:
  Exclude:
    - '108.rb'

# Offense count: 8
# Configuration parameters: AllowComments, AllowNil.
Lint/SuppressedException:
  Exclude:
    - '109.rb'
    - '110.rb'
    - '111.rb'
    - '112.rb'
    - '113.rb'

# Offense count: 3
# Configuration parameters: AllowKeywordBlockArguments.
Lint/UnderscorePrefixedVariableName:
  Exclude:
    - '114.rb'
    - '115.rb'

# Offense count: 2
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
Lint/UnusedMethodArgument:
  Exclude:
    - '116.rb'
    - '117.rb'

# Offense count: 2
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AutoCorrect.
Lint/UselessMethodDefinition:
  Exclude:
    - '118.rb'
    - '119.rb'

# Offense count: 10
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AutoCorrect.
Lint/UselessTimes:
  Exclude:
    - '120.rb'
    - '121.rb'
    - '122.rb'
    - '123.rb'
    - '124.rb'
    - '125.rb'
    - '126.rb'

# Offense count: 33
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AutoCorrect, CheckForMethodsWithNoSideEffects.
Lint/Void:
  Exclude:
    - '127.rb'
    - '128.rb'
    - '129.rb'
    - '130.rb'
    - '131.rb'
    - '132.rb'
    - '133.rb'
    - '134.rb'
    - '135.rb'
    - '136.rb'
    - '137.rb'
    - '138.rb'
    - '139.rb'
    - '140.rb'

# Offense count: 34
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
Naming/BlockParameterName:
  Exclude:
    - '141.rb'
    - '142.rb'
    - '143.rb'
    - '144.rb'
    - '145.rb'
    - '146.rb'
    - '147.rb'
    - '148.rb'
    - '149.rb'

# Offense count: 91
# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
Naming/FileName:
  Enabled: false

# Offense count: 196
# Configuration parameters: ForbiddenDelimiters.
# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
Naming/HeredocDelimiterNaming:
  Enabled: false

# Offense count: 11
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyleForLeadingUnderscores.
# SupportedStylesForLeadingUnderscores: disallowed, required, optional
Naming/MemoizedInstanceVariableName:
  Exclude:
    - '150.rb'
    - '151.rb'
    - '152.rb'
    - '153.rb'
    - '154.rb'
    - '155.rb'
    - '156.rb'
    - '157.rb'

# Offense count: 47
# Configuration parameters: EnforcedStyle, AllowedPatterns.
# SupportedStyles: snake_case, camelCase
Naming/MethodName:
  Enabled: false

# Offense count: 281
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
Naming/MethodParameterName:
  Enabled: false

# Offense count: 60
# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
# NamePrefix: is_, has_, have_
# ForbiddenPrefixes: is_, has_, have_
# AllowedMethods: is_a?
# MethodDefinitionMacros: define_method, define_singleton_method
Naming/PredicateName:
  Enabled: false

# Offense count: 541
# Configuration parameters: EnforcedStyle, AllowedIdentifiers, AllowedPatterns.
# SupportedStyles: snake_case, camelCase
Naming/VariableName:
  Enabled: false

# Offense count: 5864
# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
# SupportedStyles: snake_case, normalcase, non_integer
# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
Naming/VariableNumber:
  Enabled: false

# Offense count: 75
# Configuration parameters: MinSize.
Performance/CollectionLiteralInLoop:
  Enabled: false

# Offense count: 62
# This cop supports unsafe autocorrection (--autocorrect-all).
Performance/Count:
  Enabled: false

# Offense count: 55
# This cop supports unsafe autocorrection (--autocorrect-all).
Performance/Detect:
  Enabled: false

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: SafeMultiline.
Performance/EndWith:
  Exclude:
    - '158.rb'

# Offense count: 97
# This cop supports unsafe autocorrection (--autocorrect-all).
Performance/MapCompact:
  Enabled: false

# Offense count: 222
Performance/MapMethodChain:
  Enabled: false

# Offense count: 1
Performance/MethodObjectAsBlock:
  Exclude:
    - '159.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Performance/RangeInclude:
  Exclude:
    - '160.rb'

# Offense count: 15
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowRegexpMatch.
Performance/RedundantEqualityComparisonBlock:
  Exclude:
    - '161.rb'
    - '162.rb'
    - '163.rb'
    - '164.rb'
    - '165.rb'
    - '166.rb'

# Offense count: 15
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: MaxKeyValuePairs.
Performance/RedundantMerge:
  Exclude:
    - '167.rb'
    - '168.rb'
    - '169.rb'
    - '170.rb'
    - '171.rb'
    - '172.rb'
    - '173.rb'
    - '174.rb'
    - '175.rb'
    - '176.rb'

# Offense count: 22
# This cop supports unsafe autocorrection (--autocorrect-all).
Performance/StringInclude:
  Exclude:
    - '177.rb'
    - '178.rb'
    - '179.rb'
    - '180.rb'
    - '181.rb'
    - '182.rb'
    - '183.rb'
    - '184.rb'
    - '185.rb'
    - '186.rb'
    - '187.rb'
    - '188.rb'
    - '189.rb'
    - '190.rb'

# Offense count: 346
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: OnlySumOrWithInitialValue.
Performance/Sum:
  Enabled: false

# Offense count: 350
# This cop supports unsafe autocorrection (--autocorrect-all).
Performance/TimesMap:
  Enabled: false

# Offense count: 12
Security/Eval:
  Exclude:
    - '191.rb'
    - '192.rb'
    - '193.rb'
    - '194.rb'
    - '195.rb'
    - '196.rb'
    - '197.rb'
    - '198.rb'

# Offense count: 7
# This cop supports unsafe autocorrection (--autocorrect-all).
Security/IoMethods:
  Exclude:
    - '199.rb'
    - '200.rb'
    - '201.rb'

# Offense count: 9
Security/Open:
  Exclude:
    - '202.rb'
    - '203.rb'
    - '204.rb'
    - '205.rb'
    - '206.rb'
    - '207.rb'

# Offense count: 12
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: always, conditionals
Style/AndOr:
  Exclude:
    - '208.rb'
    - '209.rb'
    - '210.rb'
    - '211.rb'
    - '212.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/ArrayIntersect:
  Exclude:
    - '213.rb'

# Offense count: 5
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowOnConstant, AllowOnSelfClass.
Style/CaseEquality:
  Exclude:
    - '214.rb'
    - '215.rb'

# Offense count: 6
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: MinBranchesCount.
Style/CaseLikeIf:
  Exclude:
    - '216.rb'
    - '217.rb'
    - '218.rb'
    - '219.rb'
    - '220.rb'
    - '221.rb'

# Offense count: 44
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: nested, compact
Style/ClassAndModuleChildren:
  Enabled: false

# Offense count: 6
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowedMethods, AllowedPatterns.
# AllowedMethods: ==, equal?, eql?
Style/ClassEqualityComparison:
  Exclude:
    - '222.rb'
    - '223.rb'
    - '224.rb'
    - '225.rb'
    - '226.rb'

# Offense count: 28
Style/ClassVars:
  Enabled: false

# Offense count: 23
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowedReceivers.
Style/CollectionCompact:
  Exclude:
    - '227.rb'
    - '228.rb'
    - '229.rb'
    - '230.rb'
    - '231.rb'
    - '232.rb'
    - '233.rb'
    - '234.rb'

# Offense count: 44
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/CombinableLoops:
  Enabled: false

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: Keywords, RequireColon.
# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
Style/CommentAnnotation:
  Exclude:
    - '235.rb'
    - '236.rb'
    - '237.rb'

# Offense count: 14
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/CommentedKeyword:
  Exclude:
    - '238.rb'
    - '239.rb'
    - '240.rb'
    - '241.rb'
    - '242.rb'
    - '243.rb'
    - '244.rb'

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
Style/ComparableClamp:
  Exclude:
    - '245.rb'
    - '246.rb'

# Offense count: 2
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/ConcatArrayLiterals:
  Exclude:
    - '247.rb'
    - '248.rb'

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
# SupportedStyles: assign_to_condition, assign_inside_condition
Style/ConditionalAssignment:
  Exclude:
    - '249.rb'
    - '250.rb'
    - '251.rb'

# Offense count: 10
Style/DocumentDynamicEvalDefinition:
  Exclude:
    - '252.rb'
    - '253.rb'
    - '254.rb'
    - '255.rb'
    - '256.rb'
    - '257.rb'
    - '258.rb'

# Offense count: 1153
# Configuration parameters: AllowedConstants.
Style/Documentation:
  Enabled: false

# Offense count: 14
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: allowed_in_returns, forbidden
Style/DoubleNegation:
  Exclude:
    - '259.rb'
    - '260.rb'
    - '261.rb'
    - '262.rb'
    - '263.rb'
    - '264.rb'
    - '265.rb'

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AutoCorrect, EnforcedStyle, AllowComments.
# SupportedStyles: empty, nil, both
Style/EmptyElse:
  Exclude:
    - '266.rb'
    - '267.rb'
    - '268.rb'

# Offense count: 6
# This cop supports safe autocorrection (--autocorrect).
Style/EvalWithLocation:
  Exclude:
    - '269.rb'
    - '270.rb'
    - '271.rb'
    - '272.rb'

# Offense count: 4
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: left_coerce, right_coerce, single_coerce, fdiv
Style/FloatDivision:
  Exclude:
    - '273.rb'
    - '274.rb'
    - '275.rb'

# Offense count: 37
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: each, for
Style/For:
  Enabled: false

# Offense count: 21
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: format, sprintf, percent
Style/FormatString:
  Exclude:
    - '276.rb'
    - '277.rb'
    - '278.rb'
    - '279.rb'
    - '280.rb'
    - '281.rb'
    - '282.rb'
    - '283.rb'

# Offense count: 106
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyle, MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
# SupportedStyles: annotated, template, unannotated
Style/FormatStringToken:
  Exclude:
    - '284.rb'
    - '285.rb'
    - '286.rb'
    - '287.rb'
    - '288.rb'
    - '289.rb'
    - '290.rb'
    - '291.rb'
    - '292.rb'
    - '293.rb'
    - '294.rb'

# Offense count: 2635
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: always, always_true, never
Style/FrozenStringLiteralComment:
  Enabled: false

# Offense count: 3
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/GlobalStdStream:
  Exclude:
    - '295.rb'
    - '296.rb'

# Offense count: 285
# Configuration parameters: AllowedVariables.
Style/GlobalVars:
  Enabled: false

# Offense count: 4
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
Style/GuardClause:
  Exclude:
    - '297.rb'
    - '298.rb'
    - '299.rb'
    - '300.rb'

# Offense count: 37
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowSplatArgument.
Style/HashConversion:
  Enabled: false

# Offense count: 54
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowedReceivers.
# AllowedReceivers: Thread.current
Style/HashEachMethods:
  Enabled: false

# Offense count: 1
# Configuration parameters: MinBranchesCount.
Style/HashLikeCase:
  Exclude:
    - '301.rb'

# Offense count: 8
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/HashTransformKeys:
  Exclude:
    - '302.rb'
    - '303.rb'
    - '304.rb'
    - '305.rb'
    - '306.rb'
    - '307.rb'
    - '308.rb'
    - '309.rb'

# Offense count: 13
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/HashTransformValues:
  Exclude:
    - '310.rb'
    - '311.rb'
    - '312.rb'
    - '313.rb'
    - '314.rb'
    - '315.rb'
    - '316.rb'
    - '317.rb'
    - '318.rb'
    - '319.rb'

# Offense count: 18
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/IdenticalConditionalBranches:
  Exclude:
    - '320.rb'
    - '321.rb'
    - '322.rb'
    - '323.rb'
    - '324.rb'
    - '325.rb'
    - '326.rb'

# Offense count: 243
# This cop supports safe autocorrection (--autocorrect).
Style/IfUnlessModifier:
  Enabled: false

# Offense count: 3
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/InfiniteLoop:
  Exclude:
    - '327.rb'
    - '328.rb'
    - '329.rb'

# Offense count: 38
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: InverseMethods, InverseBlocks.
Style/InverseMethods:
  Enabled: false

# Offense count: 36
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: InverseMethods.
Style/InvertibleUnlessCondition:
  Enabled: false

# Offense count: 397
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/LineEndConcatenation:
  Enabled: false

# Offense count: 9
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/MapIntoArray:
  Exclude:
    - '330.rb'
    - '331.rb'
    - '332.rb'
    - '333.rb'
    - '334.rb'

# Offense count: 69
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/MapToHash:
  Enabled: false

# Offense count: 10
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/MapToSet:
  Exclude:
    - '335.rb'
    - '336.rb'
    - '337.rb'
    - '338.rb'
    - '339.rb'
    - '340.rb'

# Offense count: 7
Style/MissingRespondToMissing:
  Exclude:
    - '341.rb'
    - '342.rb'
    - '343.rb'
    - '344.rb'
    - '345.rb'
    - '346.rb'

# Offense count: 5
Style/MixinUsage:
  Exclude:
    - '347.rb'
    - '348.rb'
    - '349.rb'

# Offense count: 212
Style/MultilineBlockChain:
  Enabled: false

# Offense count: 138
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: literals, strict
Style/MutableConstant:
  Enabled: false

# Offense count: 1
# This cop supports safe autocorrection (--autocorrect).
Style/NestedModifier:
  Exclude:
    - '350.rb'

# Offense count: 7
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: IncludeSemanticChanges.
Style/NonNilCheck:
  Exclude:
    - '351.rb'
    - '352.rb'
    - '353.rb'
    - '354.rb'
    - '355.rb'
    - '356.rb'

# Offense count: 484
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
# SupportedStyles: predicate, comparison
Style/NumericPredicate:
  Enabled: false

# Offense count: 55
Style/OpenStructUse:
  Exclude:
    - '357.rb'
    - '358.rb'
    - '359.rb'
    - '360.rb'

# Offense count: 3
Style/OptionalArguments:
  Exclude:
    - '361.rb'
    - '362.rb'
    - '363.rb'

# Offense count: 172
# Configuration parameters: AllowedMethods.
# AllowedMethods: respond_to_missing?
Style/OptionalBooleanParameter:
  Enabled: false

# Offense count: 36
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: short, verbose
Style/PreferredHashMethods:
  Enabled: false

# Offense count: 81
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle, AllowedCompactTypes.
# SupportedStyles: compact, exploded
Style/RaiseArgs:
  Enabled: false

# Offense count: 5
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: Methods.
Style/RedundantArgument:
  Exclude:
    - '364.rb'
    - '365.rb'
    - '366.rb'
    - '367.rb'
    - '368.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AutoCorrect, AllowComments.
Style/RedundantInitialize:
  Exclude:
    - '369.rb'

# Offense count: 216
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/RedundantInterpolation:
  Enabled: false

# Offense count: 3
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/RedundantSelfAssignment:
  Exclude:
    - '370.rb'
    - '371.rb'

# Offense count: 5
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/RedundantSort:
  Exclude:
    - '372.rb'
    - '373.rb'
    - '374.rb'
    - '375.rb'
    - '376.rb'

# Offense count: 9
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowedMethods, AllowedPatterns.
Style/ReturnNilInPredicateMethodDefinition:
  Exclude:
    - '377.rb'
    - '378.rb'
    - '379.rb'
    - '380.rb'
    - '381.rb'
    - '382.rb'
    - '383.rb'

# Offense count: 132
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
# AllowedMethods: present?, blank?, presence, try, try!
Style/SafeNavigation:
  Enabled: false

# Offense count: 9
# Configuration parameters: Max.
Style/SafeNavigationChainLength:
  Exclude:
    - '384.rb'
    - '385.rb'
    - '386.rb'
    - '387.rb'
    - '388.rb'
    - '389.rb'
    - '390.rb'

# Offense count: 14
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/SelectByRegexp:
  Exclude:
    - '391.rb'
    - '392.rb'
    - '393.rb'
    - '394.rb'
    - '395.rb'

# Offense count: 77
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/SlicingWithRange:
  Enabled: false

# Offense count: 8
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: RequireEnglish, EnforcedStyle.
# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
Style/SpecialGlobalVars:
  Exclude:
    - '396.rb'
    - '397.rb'
    - '398.rb'
    - '399.rb'
    - '400.rb'
    - '401.rb'
    - '402.rb'

# Offense count: 174
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: Mode.
Style/StringConcatenation:
  Enabled: false

# Offense count: 11
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
  EnforcedStyle: single_quotes

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/SwapValues:
  Exclude:
    - '403.rb'

# Offense count: 763
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments.
# AllowedMethods: define_method
Style/SymbolProc:
  Enabled: false

# Offense count: 4
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
Style/TernaryParentheses:
  Exclude:
    - '404.rb'

# Offense count: 1
# This cop supports safe autocorrection (--autocorrect).
Style/WhileUntilModifier:
  Exclude:
    - '405.rb'

# Offense count: 8
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: forbid_for_all_comparison_operators, forbid_for_equality_operators_only, require_for_all_comparison_operators, require_for_equality_operators_only
Style/YodaCondition:
  Exclude:
    - '406.rb'
    - '407.rb'

# Offense count: 67
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/ZeroLengthPredicate:
  Enabled: false

I certainly did not expect that:

$ b/bin/jruby -S rubocop --format fuubar -a
b/a/c/c.rb:328:7: C: [Correctable] Style/InvertibleUnlessCondition: Prefer if sort_path.size > 1 over unless sort_path.size <= 1.
      unless sort_path.size <= 1 ...
      ^^^^^^^^^^^^^^^^^^^^^^^^^^
...
 2639/2639 files |=================== 100 ====================>| Time: 00:01:13 

2639 files inspected, 50 offenses detected, 36 more offenses can be corrected with `rubocop -A`
$ echo $?
1
$

Is it me, or RuboCop?

*: #13491

Answered by stdedos

Nov 25, 2024

Sorry - I think I have a more clear head now. I've struggled with this in the past as well.

Configuration directly in a file takes precedence over configuration in an inherited file.

Indeed, you are right. And for a good reason why this should be like that.

However, this means that for the special case that .rubocop_todo.yml represents, there is no way to deviate from RuboCop's default style and have a ToDo file.

View full answer

dvandersluis · 2024-11-25T16:36:04Z

dvandersluis
Nov 25, 2024
Collaborator

It is hard to guess what you're asking here. Please try snipping your pasted files to the relevant parts and being specific about the question you're asking.

That being said, if your surprise is that Style/InvertibleUnlessCondition is registering an offense, you have it with Enabled: false in .rubocop_todo.yml, but with Enabled: true in .rubocop.yml. Configuration directly in a file takes precedence over configuration in an inherited file.

See https://docs.rubocop.org/rubocop/1.68/configuration.html#inheritance

10 replies

stdedos Nov 25, 2024
Author

That being said, if your surprise is that Style/InvertibleUnlessCondition is registering an offense, you have it with Enabled: false in .rubocop_todo.yml, but with Enabled: true in .rubocop.yml. Configuration directly in a file takes precedence over configuration in an inherited file.

That is what I am asking here. How is it even possible???

dvandersluis Nov 25, 2024
Collaborator

If you don't want it enabled, remove the explicit enabling of the cop in .rubocop.yml.

stdedos Nov 25, 2024
Author

I want it enabled! But it cannot be autofixed - so I don't want RuboCop to complain about it i.e. break the pipeline on current offences

stdedos Nov 25, 2024
Author

Sorry - I think I have a more clear head now. I've struggled with this in the past as well.

Configuration directly in a file takes precedence over configuration in an inherited file.

Indeed, you are right. And for a good reason why this should be like that.

However, this means that for the special case that .rubocop_todo.yml represents, there is no way to deviate from RuboCop's default style and have a ToDo file.

Answer selected by stdedos

dvandersluis Nov 25, 2024
Collaborator

However, this means that for the special case that .rubocop_todo.yml represents, there is no way to deviate from RuboCop's default style and have a ToDo file

This is not the case, you can definitely use a todo file with your own configuration. However, if you have a ton of offenses, by default the todo file will disable the cop. If you then enable the cop yourself, it will report all offenses, because the value set in the todo file is overridden.

There’s a few options:

Tag each offense with rubocop:todo comments. You can use the --disable-uncorrectable flag to add these automatically. Note that if you’ve disabled a cop in your todo file and not reenabled it in your main configuration, you may need to remove the block from todo to make these offenses get flagged. See https://docs.rubocop.org/rubocop/usage/auto_correct.html#generating-comments
Use --auto-gen-config --auto-gen-only-exclude with --exclude-limit N (where N is an integer count of the maximum number of occurrences) or --no-exclude-limit to have specific files to be excluded listed in .rubocop_todo.yml instead of having cops disabled, up to the maximum (or for all of them if no maximum). See https://docs.rubocop.org/rubocop/configuration.html#automatically-generated-configuration
Run rubocop with --display-only-correctable or --display-only-safe-correctable to not output offenses that cannot be (safely) autocorrected.
You are working with a cop that has autocorrection (the output you pasted even shows [Correctable]) so you could let it fix the existing issues? You may need to use -A/--autocorrect-all if the cop does not have safe autocorrection, in which case you should review the corrections before accepting them. The cop documentation will let you know what cops are unsafe and why.

stdedos Nov 26, 2024
Author

If you then enable the cop yourself, it will report all offenses, because the value set in the todo file is overridden.

We are getting a bit into semantics territory here. https://docs.rubocop.org/rubocop/cops_style.html#styleinvertibleunlesscondition says

Enabled by default Safe Supports autocorrection Version Added Version Changed

Disabled No Always (Unsafe) 1.44 1.50

So, if I want to use Style/InvertibleUnlessCondition, I MUST enable it. Then, because "fixing it is not complete yet", it MUST be disabled - and the correct place to do this is in the ToDo file.

I hear what you are saying - and I've already said inherit-wise it makes TOTAL SENSE.
And here is one place it fails - the "special" .rubocop_todo.yml

Is the most feasible - even if I disagree with polluting the source code. I don't remember if a useless rubocop:todo is flagged. A useless .rubocop_todo.yml line is not (When a .rubocop_todo.yml exclude is not useful anymore, instead raise a (correctable) offense #13037).
--no-exclude-limit would be the only option IMO - but idk if "unlimited" results are a problem (e.g. RuboCop performance and/or "according to the repository participants"). See also 1
What about new non-.rubocop_todo.yml uncorrectable offences? CI/CD disagrees with that 😕
"Maybe". But first I have to review the first batch (and hopefully we'll decide big-bang rubocop -a 2k files commit), and then we could try that.

dvandersluis Nov 26, 2024
Collaborator

.rubocop_todo.yml is not special, aside from the fact that it's automatically generated. Nothing in it is treated differently than inheriting from any other configuration file. The way it is generated is dependent on a number of flags, please take a look at the "Config Generation" section of rubocop --help. You have control over it, to an extent. The default way the todo is generated is to disable cops that register offenses in more than 15 files, that is why you're getting Enabled: false. If you want to list files instead, use the options to do so (--auto-gen-only-exclude --no-exclude-limit).

You can also forego generating an automatic todo file, and handle things to be done later in your own configuration file, or a separate configuration file you add to the inherit_from array in your main config. A pattern I often use is to create separate todo files when upgrading rubocop so that offenses from new are tracked separately from longstanding ones, until they can be worked on.

So, if I want to use Style/InvertibleUnlessCondition, I MUST enable it. Then, because "fixing it is not complete yet", it MUST be disabled - and the correct place to do this is in the ToDo file.

A cop cannot be enabled and disabled at the same time. If you want the cop to be enabled, you can exclude files you don't want it to cover, or you can inline disable it (using comments) to have more fine-grained control. This is not a factor of the cop being disabled by default either, the default config is just the lowest on the configuration inheritence hierarchy, and higher values override:

# rubocop/config/default.yml

Style/InvertibleUnlessCondition:
  Enabled: false

# ... overridden by (with no change since it's the same value) ...
# yourcode/.rubocop_todo.yml

Style/InvertibleUnlessCondition:
  Enabled: false

# ... overridden by ...
# yourcode/.rubocop.yml

Style/InvertibleUnlessCondition:
  Enabled: true

Only the highest value "wins". (Note there is the ability to merge inherited values together, but that's for things like Exclude that are arrays; boolean values cannot be merged)

I don't remember if a useless rubocop:todo is flagged.

Lint/RedundantCopDisableDirective will flag unnecessary rubocop:todo comments.

--no-exclude-limit would be the only option IMO - but idk if "unlimited" results are a problem (e.g. RuboCop performance and/or "according to the repository participants")

You'd have to try it and see. I've used --no-exclude-limit extensively on my codebases and haven't noticed any problems, but I don't know the quantity of offenses you're running into.

Ultimately you have to decide what works for you and your team. I question I'd ask your colleagues if I was working on your codebase is if there is value enabling cops that have so many offenses already. I would likely not do so without committing to immediately dealing with the existing issues.

stdedos Nov 27, 2024
Author

I question I'd ask your colleagues if I was working on your codebase is if there is value enabling cops that have so many offenses already. I would likely not do so without committing to immediately dealing with the existing issues.

Well ... we do want to enforce that style and it is written on the Wiki that it is the correct style 🤷

I guess --no-exclude-limit is the only viable way
(which still lacks #13037 😕)

Uh oh!

.rubocop_todo.yml: Enabling and todo-disabling an offence at the same time #13492

Uh oh!

Uh oh!

stdedos Nov 25, 2024

Replies: 1 comment · 10 replies

Uh oh!

dvandersluis Nov 25, 2024 Collaborator

Uh oh!

stdedos Nov 25, 2024 Author

Uh oh!

dvandersluis Nov 25, 2024 Collaborator

Uh oh!

stdedos Nov 25, 2024 Author

Uh oh!

stdedos Nov 25, 2024 Author

Uh oh!

Uh oh!

dvandersluis Nov 25, 2024 Collaborator

Uh oh!

Uh oh!

stdedos Nov 26, 2024 Author

Uh oh!

Uh oh!

dvandersluis Nov 26, 2024 Collaborator

Uh oh!

Uh oh!

stdedos Nov 27, 2024 Author

`.rubocop_todo.yml`: Enabling and todo-disabling an offence at the same time #13492

stdedos
Nov 25, 2024

Replies: 1 comment 10 replies

dvandersluis
Nov 25, 2024
Collaborator

stdedos Nov 25, 2024
Author

dvandersluis Nov 25, 2024
Collaborator

stdedos Nov 25, 2024
Author

stdedos Nov 25, 2024
Author

dvandersluis Nov 25, 2024
Collaborator

stdedos Nov 26, 2024
Author

dvandersluis Nov 26, 2024
Collaborator

stdedos Nov 27, 2024
Author