.rubocop.yml from puppetlabs/chloride

.rubocop.yml
Summary

Maintainability

Test Coverage

Issues
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2016-10-21 10:10:42 -0700 using RuboCop version 0.44.1.
# 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.

AllCops:
  TargetRubyVersion: 2.4

# Offense count: 6
# Configuration parameters: AllowSafeAssignment.
Lint/AssignmentInCondition:
  Exclude:
    - 'lib/chloride/host.rb'

Lint/SuppressedException:
  Enabled: true

Lint/RescueException:
  Enabled: true

# Offense count: 5
Lint/ShadowingOuterLocalVariable:
  Exclude:
    - 'lib/chloride/host.rb'

# Cop supports --auto-correct.
Lint/RedundantStringCoercion:
  Enabled: true
  AutoCorrect: true

Lint/UnderscorePrefixedVariableName:
  Enabled: true

# Cop supports --auto-correct.
# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
Lint/UnusedBlockArgument:
  Enabled: true
  AutoCorrect: false

# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
Lint/UnusedMethodArgument:
  Enabled: true

Lint/UselessAssignment:
  Enabled: true

# Offense count: 1
Lint/Void:
  Enabled: true

# Offense count: 6
Metrics/AbcSize:
  Enabled: false
  Max: 70

# Offense count: 4
# Configuration parameters: CountComments.
Metrics/BlockLength:
  Enabled: false
  Max: 45

Metrics/BlockNesting:
  Max: 4

# Offense count: 1
# Configuration parameters: CountComments.
Metrics/ClassLength:
  Max: 205

# Offense count: 2
Metrics/CyclomaticComplexity:
  Enabled: false
  Max: 20

# Offense count: 10
# Configuration parameters: CountComments.
Metrics/MethodLength:
  Enabled: false
  Max: 89

# Offense count: 2
Metrics/PerceivedComplexity:
  Enabled: false
  Max: 23

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
# SupportedStyles: line_count_based, semantic, braces_for_chaining
# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
# FunctionalMethods: let, let!, subject, watch
# IgnoredMethods: lambda, proc, it
Style/BlockDelimiters:
  AutoCorrect: false
  Exclude:
    - 'lib/chloride/host.rb'

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: braces, no_braces, context_dependent
Style/BracesAroundHashParameters:
  AutoCorrect: true

# Offense count: 8
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: nested, compact
Style/ClassAndModuleChildren:
  Enabled: false
  Exclude:
    - 'lib/chloride/action/execute.rb'
    - 'lib/chloride/action/file_copy.rb'
    - 'lib/chloride/action/mkdir.rb'
    - 'lib/chloride/action/mktmp.rb'
    - 'lib/chloride/action/resolve_dns.rb'
    - 'lib/chloride/errors.rb'
    - 'lib/chloride/event.rb'
    - 'lib/chloride/host.rb'

# Cop supports --auto-correct.
Style/ColonMethodCall:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly.
# SupportedStyles: assign_to_condition, assign_inside_condition
Style/ConditionalAssignment:
  AutoCorrect: true

# Offense count: 11
Style/Documentation:
  Exclude:
    - 'spec/**/*'
    - 'test/**/*'
    - 'lib/chloride.rb'
    - 'lib/chloride/action.rb'
    - 'lib/chloride/action/execute.rb'
    - 'lib/chloride/action/file_copy.rb'
    - 'lib/chloride/action/mkdir.rb'
    - 'lib/chloride/action/mktmp.rb'
    - 'lib/chloride/action/resolve_dns.rb'
    - 'lib/chloride/errors.rb'
    - 'lib/chloride/event.rb'
    - 'lib/chloride/event/message.rb'
    - 'lib/chloride/executor.rb'
    - 'lib/chloride/host.rb'
    - 'lib/chloride/step.rb'
    - 'lib/chloride/step/noop.rb'

# Cop supports --auto-correct.
Layout/EmptyLines:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
Layout/ExtraSpacing:
  AutoCorrect: true

# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: format, sprintf, percent
Style/FormatString:
  Enabled: true

# Offense count: 6
# Configuration parameters: MinBodyLength.
Style/GuardClause:
  Exclude:
    - 'lib/chloride/action/execute.rb'
    - 'lib/chloride/action/mkdir.rb'
    - 'lib/chloride/action/mktmp.rb'
    - 'lib/chloride/host.rb'

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
Style/HashSyntax:
  AutoCorrect: true

# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: normal, rails
Layout/IndentationConsistency:
  Enabled: true

# Cop supports --auto-correct.
# Configuration parameters: Width.
Layout/IndentationWidth:
  AutoCorrect: true

# Cop supports --auto-correct.
Layout/LeadingCommentSpace:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: symmetrical, new_line, same_line
Layout/MultilineMethodCallBraceLayout:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/MutableConstant:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/NegatedIf:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: AutoCorrect, EnforcedStyle, SupportedStyles.
# SupportedStyles: predicate, comparison
Style/NumericPredicate:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: AllowSafeAssignment.
Style/ParenthesesAroundCondition:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: PreferredDelimiters.
Style/PercentLiteralDelimiters:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: short, verbose
Style/PreferredHashMethods:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/Proc:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/RedundantParentheses:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: AllowMultipleReturnValues.
Style/RedundantReturn:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/RedundantSelf:
  AutoCorrect: true

# Cop supports --auto-correct.
Layout/SpaceAfterComma:
  AutoCorrect: true

# Cop supports --auto-correct.
Layout/SpaceAfterNot:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: space, no_space
Layout/SpaceAroundEqualsInParameterDefault:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment.
Layout/SpaceAroundOperators:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: space, no_space
Layout/SpaceBeforeBlockBraces:
  Enabled: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
# SupportedStyles: space, no_space
Layout/SpaceInsideBlockBraces:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
# SupportedStyles: space, no_space, compact
Layout/SpaceInsideHashLiteralBraces:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
  Enabled: true
  AutoCorrect: true

Style/FrozenStringLiteralComment:
  Enabled: false

# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiteralsInInterpolation:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowSafeAssignment.
# SupportedStyles: require_parentheses, require_no_parentheses
Style/TernaryParentheses:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
# SupportedStyles: comma, consistent_comma, no_comma
Style/TrailingCommaInArrayLiteral:
  AutoCorrect: true
Style/TrailingCommaInHashLiteral:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
Style/TrivialAccessors:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/UnlessElse:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/RedundantInterpolation:
  AutoCorrect: true

# Cop supports --auto-correct.
Style/RedundantPercentQ:
  AutoCorrect: true

# Cop supports --auto-correct.
# Configuration parameters: SupportedStyles, WordRegex.
# SupportedStyles: percent, brackets
Style/WordArray:
  AutoCorrect: true
  EnforcedStyle: percent
  MinSize: 8

# Cop supports --auto-correct.
Style/ZeroLengthPredicate:
  AutoCorrect: true

# I'll be a terse as I want to
Naming/MethodParameterName:
  Enabled: false

# Don't like the %i style.
Style/SymbolArray:
  Enabled: false

# if code_is_poetry
#   make_a_block_if_you_want_to
# end
Style/IfUnlessModifier:
  Enabled: false

Metrics/LineLength:
  Enabled: false

# We're ok with using variable names (` Exception => err`) 
#   for exceptions, not just `Exception => e`
Naming/RescuedExceptionsVariableName:
  Enabled: false