dblock/ruby-link-checker

View on GitHub
.rubocop_todo.yml

Summary

Maintainability
Test Coverage
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2023-04-03 00:36:28 UTC using RuboCop version 1.48.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.

# Offense count: 1
# Configuration parameters: EnforcedStyle, AllowedGems, Include.
# SupportedStyles: Gemfile, gems.rb, gemspec
# Include: **/*.gemspec, **/Gemfile, **/gems.rb
Gemspec/DevelopmentDependencies:
  Exclude:
    - 'ruby-link-checker.gemspec'

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

# Offense count: 1
# This cop supports safe autocorrection (--autocorrect).
Layout/EmptyLineAfterGuardClause:
  Exclude:
    - 'lib/ruby-link-checker/checker.rb'

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
Layout/EmptyLineAfterMagicComment:
  Exclude:
    - 'lib/ruby-link-checker/logger.rb'
    - 'spec/ruby-link-checker/checker_spec.rb'
    - 'spec/ruby-link-checker/config_spec.rb'

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: Width, AllowedPatterns.
Layout/IndentationWidth:
  Exclude:
    - 'spec/ruby-link-checker/checker_spec.rb'
    - 'spec/ruby-link-checker/config_spec.rb'

# Offense count: 4
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: final_newline, final_blank_line
Layout/TrailingEmptyLines:
  Exclude:
    - 'lib/ruby-link-checker/logger.rb'
    - 'spec/ruby-link-checker/checker_spec.rb'
    - 'spec/ruby-link-checker/config_spec.rb'
    - 'spec/spec_helper.rb'

# Offense count: 1
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowInHeredoc.
Layout/TrailingWhitespace:
  Exclude:
    - 'spec/ruby-link-checker/config_spec.rb'

# Offense count: 1
# Configuration parameters: AllowedMethods.
# AllowedMethods: enums
Lint/ConstantDefinitionInBlock:
  Exclude:
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'

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

# Offense count: 1
# 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:
  Exclude:
    - 'lib/ruby-link-checker.rb'

# Offense count: 1
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
Naming/MethodParameterName:
  Exclude:
    - 'lib/ruby-link-checker/callbacks.rb'

# Offense count: 3
RSpec/AnyInstance:
  Exclude:
    - 'spec/ruby-link-checker/net/http/checker_spec.rb'
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'

# Offense count: 1
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: be, be_nil
RSpec/BeNil:
  Exclude:
    - 'spec/ruby-link-checker/config_spec.rb'

# Offense count: 2
RSpec/BeforeAfterAll:
  Exclude:
    - 'spec/spec_helper.rb'
    - 'spec/rails_helper.rb'
    - 'spec/support/**/*.rb'
    - 'spec/ruby-link-checker/net/http/checker_spec.rb'
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'

# Offense count: 34
# Configuration parameters: Prefixes, AllowedPatterns.
# Prefixes: when, with, without
RSpec/ContextWording:
  Exclude:
    - 'spec/ruby-link-checker/callbacks_spec.rb'
    - 'spec/ruby-link-checker/checker_spec.rb'
    - 'spec/ruby-link-checker/config_spec.rb'
    - 'spec/ruby-link-checker/net/http/checker_spec.rb'
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'
    - 'spec/support/link_checker.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: SkipBlocks, EnforcedStyle.
# SupportedStyles: described_class, explicit
RSpec/DescribedClass:
  Exclude:
    - 'spec/ruby-link-checker/checker_spec.rb'

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowConsecutiveOneLiners.
RSpec/EmptyLineAfterExample:
  Exclude:
    - 'spec/ruby-link-checker/config_spec.rb'

# Offense count: 13
# Configuration parameters: CountAsOne.
RSpec/ExampleLength:
  Max: 9

# Offense count: 3
RSpec/ExpectInHook:
  Exclude:
    - 'spec/ruby-link-checker/net/http/checker_spec.rb'
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'

# Offense count: 6
# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
# Include: **/*_spec*rb*, **/spec/**/*
RSpec/FilePath:
  Exclude:
    - 'spec/ruby-link-checker/callbacks_spec.rb'
    - 'spec/ruby-link-checker/checker_spec.rb'
    - 'spec/ruby-link-checker/config_spec.rb'
    - 'spec/ruby-link-checker/net/http/checker_spec.rb'
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'
    - 'spec/ruby-link-checker/version_spec.rb'

# Offense count: 6
# Configuration parameters: AssignmentOnly.
RSpec/InstanceVariable:
  Exclude:
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'
    - 'spec/support/link_checker.rb'
    - 'spec/support/with_result.rb'

# Offense count: 3
RSpec/LeakyConstantDeclaration:
  Exclude:
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'

# Offense count: 1
# Configuration parameters: EnforcedStyle.
# SupportedStyles: have_received, receive
RSpec/MessageSpies:
  Exclude:
    - 'spec/ruby-link-checker/typhoeus/hydra/checker_spec.rb'

# Offense count: 21
RSpec/MultipleExpectations:
  Max: 9

# Offense count: 57
# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
# SupportedStyles: always, named_only
RSpec/NamedSubject:
  Exclude:
    - 'spec/ruby-link-checker/callbacks_spec.rb'
    - 'spec/support/link_checker.rb'
    - 'spec/support/with_result.rb'
    - 'spec/support/with_url.rb'

# Offense count: 25
# Configuration parameters: AllowedGroups.
RSpec/NestedGroups:
  Max: 6

# Offense count: 39
RSpec/SubjectStub:
  Exclude:
    - 'spec/ruby-link-checker/callbacks_spec.rb'
    - 'spec/support/link_checker.rb'
    - 'spec/support/with_result.rb'

# Offense count: 2
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowOnConstant, AllowOnSelfClass.
Style/CaseEquality:
  Exclude:
    - 'spec/support/link_checker.rb'

# Offense count: 20
# Configuration parameters: AllowedConstants.
Style/Documentation:
  Exclude:
    - 'spec/**/*'
    - 'test/**/*'
    - 'lib/ruby-link-checker/callbacks.rb'
    - 'lib/ruby-link-checker/checker.rb'
    - 'lib/ruby-link-checker/config.rb'
    - 'lib/ruby-link-checker/errors/redirect_loop_error.rb'
    - 'lib/ruby-link-checker/logger.rb'
    - 'lib/ruby-link-checker/net/http/checker.rb'
    - 'lib/ruby-link-checker/net/http/config.rb'
    - 'lib/ruby-link-checker/net/http/result.rb'
    - 'lib/ruby-link-checker/result.rb'
    - 'lib/ruby-link-checker/task.rb'
    - 'lib/ruby-link-checker/tasks.rb'
    - 'lib/ruby-link-checker/typhoeus/hydra/checker.rb'
    - 'lib/ruby-link-checker/typhoeus/hydra/config.rb'
    - 'lib/ruby-link-checker/typhoeus/hydra/result.rb'

# Offense count: 15
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle.
# SupportedStyles: always, always_true, never
Style/FrozenStringLiteralComment:
  Exclude:
    - 'benchmarks/check.rb'
    - 'lib/ruby-link-checker/errors.rb'
    - 'lib/ruby-link-checker/net/http.rb'
    - 'lib/ruby-link-checker/net/http/checker.rb'
    - 'lib/ruby-link-checker/net/http/result.rb'
    - 'lib/ruby-link-checker/result.rb'
    - 'lib/ruby-link-checker/task.rb'
    - 'lib/ruby-link-checker/tasks.rb'
    - 'lib/ruby-link-checker/typhoeus/hydra.rb'
    - 'lib/ruby-link-checker/typhoeus/hydra/checker.rb'
    - 'lib/ruby-link-checker/typhoeus/hydra/result.rb'
    - 'spec/support/config.rb'
    - 'spec/support/link_checker.rb'
    - 'spec/support/with_result.rb'
    - 'spec/support/with_url.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/GlobalStdStream:
  Exclude:
    - 'lib/ruby-link-checker/logger.rb'

# Offense count: 1
Style/MissingRespondToMissing:
  Exclude:
    - 'lib/ruby-link-checker/callbacks.rb'

# Offense count: 3
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle, Autocorrect.
# SupportedStyles: module_function, extend_self, forbidden
Style/ModuleFunction:
  Exclude:
    - 'lib/ruby-link-checker/config.rb'
    - 'lib/ruby-link-checker/net/http/config.rb'
    - 'lib/ruby-link-checker/typhoeus/hydra/config.rb'

# Offense count: 2
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
# SupportedStyles: predicate, comparison
Style/NumericPredicate:
  Exclude:
    - 'spec/**/*'
    - 'lib/ruby-link-checker/tasks.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: Mode.
Style/StringConcatenation:
  Exclude:
    - 'lib/ruby-link-checker/result.rb'

# Offense count: 2
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
  Exclude:
    - 'lib/ruby-link-checker/checker.rb'

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