Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable Additional Rubocop Extensions #9216

Merged
merged 3 commits into from
Jan 23, 2024
Merged

Enable Additional Rubocop Extensions #9216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e91a7b
Add rubocop-performance extension
mhashizume Jan 22, 2024
30c0d22
Add rubocop-rake extension
mhashizume Jan 22, 2024
57babd5
Add rubocop-rspec extension
mhashizume Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 additions & 1 deletion .rubocop.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
inherit_from: .rubocop_todo.yml

require:
rubocop-i18n
- rubocop-i18n
- rubocop-performance
- rubocop-rake
- rubocop-rspec

AllCops:
TargetRubyVersion: 2.5
Expand Down Expand Up @@ -154,3 +157,45 @@ Naming/VariableName:

Naming/VariableNumber:
Enabled: false

Performance/AncestorsInclude: # new in 1.7
Enabled: true

Performance/BigDecimalWithNumericArgument: # new in 1.7
Enabled: true

Performance/ConcurrentMonotonicTime: # new in 1.12
Enabled: true

Performance/MapCompact: # new in 1.11
Enabled: true

Performance/RedundantSortBlock: # new in 1.7
Enabled: true

Performance/ReverseFirst: # new in 1.7
Enabled: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these cops would be good to fix like the RedundantSortBlock. Should they go in the todo file instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is that the pending cops (including RedundantSortBlock) that I've added here in .rubocop.yml are enabled but found no offenses.

I wanted to specify pending cops in .rubocop.yml that didn't require any changes so that we wouldn't need to come back later to enable them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah cool, makes sense


RSpec/BeEq: # new in 2.9.0
Enabled: true

RSpec/BeNil: # new in 2.9.0
Enabled: true

RSpec/ExcessiveDocstringSpacing: # new in 2.5
Enabled: true

RSpec/IdenticalEqualityAssertion: # new in 2.4
Enabled: true

RSpec/SubjectDeclaration: # new in 2.5
Enabled: true

RSpec/VerifiedDoubleReference: # new in 2.10.0
Enabled: true

RSpec/FactoryBot/SyntaxMethods: # new in 2.7
Enabled: true

RSpec/Rails/AvoidSetupHook: # new in 2.4
Enabled: true
116 changes: 102 additions & 14 deletions .rubocop_todo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,22 @@ I18n/RailsI18n/DecorateString:
# Configuration parameters: AllowedMethods.
# AllowedMethods: enums
Lint/ConstantDefinitionInBlock:
Enabled: false
Exclude:
- 'lib/puppet/face/config.rb'
- 'lib/puppet/face/help.rb'
- 'lib/puppet/face/node/clean.rb'
- 'lib/puppet/provider/package/aix.rb'
- 'lib/puppet/provider/package/apt.rb'
- 'lib/puppet/provider/package/gem.rb'
- 'lib/puppet/provider/package/pip.rb'
- 'lib/puppet/provider/package/yum.rb'
- 'lib/puppet/provider/service/upstart.rb'
- 'lib/puppet/provider/user/directoryservice.rb'
- 'lib/puppet/type/file.rb'
- 'lib/puppet/type/file/source.rb'
- 'lib/puppet/type/resources.rb'
- 'lib/puppet/type/schedule.rb'
- 'lib/puppet/type/tidy.rb'

Lint/MissingSuper:
Enabled: false
Expand Down Expand Up @@ -85,6 +100,90 @@ Lint/ToJSON:
Lint/UnusedMethodArgument:
Enabled: false

Performance/BlockGivenWithExplicitBlock: # new in 1.9
Enabled: false

Performance/CollectionLiteralInLoop: # new in 1.8
Enabled: false

Performance/ConstantRegexp: # new in 1.9
Enabled: false

# This cop supports safe auto-correction (--auto-correct).
Performance/Count:
Exclude:
- 'lib/puppet/confine/any.rb'
- 'lib/puppet/confine/false.rb'
- 'lib/puppet/confine/true.rb'
- 'lib/puppet/graph/relationship_graph.rb'
- 'lib/puppet/provider.rb'

# This cop supports unsafe auto-correction (--auto-correct-all).
Performance/InefficientHashSearch:
Exclude:
- 'lib/puppet/face/node/clean.rb'
- 'lib/puppet/provider/nameservice/directoryservice.rb'
- 'lib/puppet/provider/user/directoryservice.rb'
- 'lib/puppet/resource.rb'
- 'lib/puppet/util/windows/adsi.rb'

Performance/MethodObjectAsBlock: # new in 1.9
Enabled: false

# This cop supports safe auto-correction (--auto-correct).
Performance/RedundantBlockCall:
Exclude:
- 'lib/puppet/application.rb'
- 'lib/puppet/context.rb'
- 'lib/puppet/file_bucket/file.rb'
- 'lib/puppet/functions/max.rb'
- 'lib/puppet/functions/min.rb'
- 'lib/puppet/gettext/stubs.rb'
- 'lib/puppet/network/http/api/server/v3.rb'
- 'lib/puppet/pal/pal_impl.rb'
- 'lib/puppet/pops/adaptable.rb'
- 'lib/puppet/pops/lookup/invocation.rb'
- 'lib/puppet/pops/model/factory.rb'
- 'lib/puppet/util.rb'

Performance/RedundantEqualityComparisonBlock: # new in 1.10
Enabled: false

# This cop supports unsafe auto-correction (--auto-correct-all).
# Configuration parameters: MaxKeyValuePairs.
Performance/RedundantMerge:
Exclude:
- 'lib/puppet/x509/cert_provider.rb'

Performance/RedundantSplitRegexpArgument: # new in 1.10
Enabled: false

Performance/RedundantStringChars: # new in 1.7
Enabled: false

# This cop supports safe auto-correction (--auto-correct).
Performance/RegexpMatch:
Enabled: false

Performance/SortReverse: # new in 1.7
Enabled: false

Performance/Squeeze: # new in 1.7
Enabled: false

Performance/StringIdentifierArgument: # new in 1.13
Enabled: false

Performance/StringInclude: # new in 1.7
Enabled: false

Performance/Sum: # new in 1.8
Enabled: false

# This cop supports safe auto-correction (--auto-correct).
Performance/UnfreezeString:
Enabled: false

# Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols.
# SupportedStyles: inline, group
Style/AccessModifierDeclarations:
Expand Down Expand Up @@ -280,7 +379,6 @@ Style/EmptyBlockParameter:
# This cop supports safe auto-correction (--auto-correct).
Style/EmptyCaseCondition:
Exclude:
- 'lib/puppet/pops/lookup/hiera_config.rb'
- 'lib/puppet/pops/serialization/serializer.rb'
- 'lib/puppet/pops/types/type_calculator.rb'
- 'lib/puppet/settings.rb'
Expand All @@ -298,7 +396,6 @@ Style/EmptyElse:
# This cop supports safe auto-correction (--auto-correct).
Style/EmptyLiteral:
Exclude:
- 'lib/puppet/indirector/face.rb'
- 'lib/puppet/parser/scope.rb'
- 'lib/puppet/pops/puppet_stack.rb'
- 'lib/puppet/pops/visitor.rb'
Expand Down Expand Up @@ -327,11 +424,6 @@ Style/Encoding:
- 'lib/puppet/type/package.rb'
- 'lib/puppet/util/windows/service.rb'

# This cop supports safe auto-correction (--auto-correct).
Style/EvalWithLocation:
Exclude:
- 'lib/puppet/interface/action_builder.rb'

# This cop supports safe auto-correction (--auto-correct).
Style/EvenOdd:
Exclude:
Expand Down Expand Up @@ -511,7 +603,6 @@ Style/MethodDefParentheses:
Exclude:
- 'lib/puppet/pops/evaluator/evaluator_impl.rb'
- 'lib/puppet/pops/evaluator/relationship_operator.rb'
- 'lib/puppet/pops/evaluator/runtime3_support.rb'
- 'lib/puppet/pops/issues.rb'
- 'lib/puppet/pops/label_provider.rb'
- 'lib/puppet/pops/model/factory.rb'
Expand Down Expand Up @@ -622,7 +713,6 @@ Style/NestedModifier:
Style/NestedParenthesizedCalls:
Exclude:
- 'lib/puppet/provider/user/directoryservice.rb'
- 'lib/puppet/type/service.rb'

# This cop supports safe auto-correction (--auto-correct).
Style/NestedTernaryOperator:
Expand All @@ -648,7 +738,6 @@ Style/Next:
# SupportedStyles: predicate, comparison
Style/NilComparison:
Exclude:
- 'lib/puppet/pops/model/ast.rb'
- 'lib/puppet/pops/types/type_factory.rb'
- 'lib/puppet/pops/types/types.rb'
- 'lib/puppet/provider/package/dnfmodule.rb'
Expand Down Expand Up @@ -681,7 +770,7 @@ Style/NumericLiteralPrefix:
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: Strict, AllowedNumbers.
Style/NumericLiterals:
MinDigits: 20
MinDigits: 11

# This cop supports unsafe auto-correction (--auto-correct-all).
# Configuration parameters: EnforcedStyle, IgnoredMethods.
Expand Down Expand Up @@ -832,7 +921,6 @@ Style/RedundantException:
# Configuration parameters: SafeForConstants.
Style/RedundantFetchBlock:
Exclude:
- 'lib/puppet/pops/model/ast.rb'
- 'lib/puppet/pops/types/p_sem_ver_range_type.rb'

# This cop supports safe auto-correction (--auto-correct).
Expand Down Expand Up @@ -1187,4 +1275,4 @@ Style/ZeroLengthPredicate:
# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
# URISchemes: http, https
Layout/LineLength:
Enabled: false
Max: 582
3 changes: 3 additions & 0 deletions Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ group(:test) do

gem 'rubocop', '1.28.0', require: false, platforms: [:ruby]
gem 'rubocop-i18n', '~> 3.0', require: false, platforms: [:ruby]
gem 'rubocop-performance', '1.13.3', require: false, platforms: [:ruby]
gem 'rubocop-rake', '0.6.0', require: false, platforms: [:ruby]
gem 'rubocop-rspec', '2.10.0', require: false, platforms: [:ruby]
end

group(:development, optional: true) do
Expand Down