diff --git a/.rubocop.yml b/.rubocop.yml index e4b8b86ad..a35001a93 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,69 +1,80 @@ -AllCops: - TargetRubyVersion: 2.6 - NewCops: enable +inherit_from: + - ../.rubocop.yml -Style/StringLiterals: - EnforcedStyle: double_quotes - -Style/StringLiteralsInInterpolation: - EnforcedStyle: double_quotes - -Style/TrailingCommaInArrayLiteral: - EnforcedStyleForMultiline: comma - -Style/TrailingCommaInHashLiteral: - EnforcedStyleForMultiline: comma - -Style/FormatString: - EnforcedStyle: percent - -# we prefer compact if-else-end/case-when-end alignment -Layout/EndAlignment: - EnforcedStyleAlignWith: variable - -Style/HashSyntax: - EnforcedStyle: hash_rockets - -Style/TrailingCommaInArguments: - EnforcedStyleForMultiline: no_comma - -Layout/CaseIndentation: - EnforcedStyle: end - -# TODO: re-enable in the future -Layout/LineLength: - Enabled: false - -Metrics/AbcSize: - Enabled: false - -Metrics/ClassLength: +Bundler/GemFilename: Enabled: false -Metrics/CyclomaticComplexity: - Enabled: false - -Metrics/MethodLength: - Enabled: false - -Metrics/ModuleLength: - Enabled: false - -Metrics/ParameterLists: - Enabled: false - -Metrics/PerceivedComplexity: - Enabled: false - -Naming/MethodParameterName: - Enabled: false - -Naming/VariableNumber: - CheckSymbols: false +Homebrew/MoveToExtendOS: + Enabled: true Exclude: - - 'test/**' - -Metrics/BlockLength: + - "{extend,test,requirements}/**/*" + - "os.rb" + +Naming/PredicateName: + inherit_mode: + merge: + - AllowedMethods + AllowedMethods: + - is_32_bit? + - is_64_bit? + +# Only enforce documentation for public APIs. +# Checked by the tests.yml syntax job +Style/Documentation: + AllowedConstants: + - Homebrew + Include: + - cask/cask.rb + - cask/dsl.rb + - cask/dsl/version.rb + - cask/url.rb + - development_tools.rb + - download_strategy.rb + - extend/ENV/super.rb + - extend/kernel.rb + - extend/pathname.rb + - formula.rb + - formula_assertions.rb + - formula_free_port.rb + - language/go.rb + - language/java.rb + - language/node.rb + - language/perl.rb + - language/python.rb + - livecheck/strategy/apache.rb + - livecheck/strategy/bitbucket.rb + - livecheck/strategy/cpan.rb + - livecheck/strategy/crate.rb + - livecheck/strategy/extract_plist.rb + - livecheck/strategy/git.rb + - livecheck/strategy/github_latest.rb + - livecheck/strategy/github_releases.rb + - livecheck/strategy/gnome.rb + - livecheck/strategy/gnu.rb + - livecheck/strategy/hackage.rb + - livecheck/strategy/json.rb + - livecheck/strategy/launchpad.rb + - livecheck/strategy/npm.rb + - livecheck/strategy/page_match.rb + - livecheck/strategy/pypi.rb + - livecheck/strategy/sourceforge.rb + - livecheck/strategy/sparkle.rb + - livecheck/strategy/xml.rb + - livecheck/strategy/xorg.rb + - livecheck/strategy/yaml.rb + - os.rb + - resource.rb + - utils/inreplace.rb + - utils/shebang.rb + - utils/string_inreplace_extension.rb + - version.rb + - tap.rb + +Homebrew/NegateInclude: Exclude: - - 'test/**' + # YARD runs stand-alone. + - yard/docstring_parser.rb +Style/DocumentationMethod: + Include: + - "formula.rb"