diff --git a/Library/.rubocop_cask.yml b/Library/.rubocop_cask.yml index cc6ccf9a5f5552e8b05cc0bc4495a696f04f5f00..e4c4939a3859f6f83c780f8d50f232d50de83722 100644 --- a/Library/.rubocop_cask.yml +++ b/Library/.rubocop_cask.yml @@ -27,5 +27,9 @@ Cask/StanzaOrder: # don't want these for casks but re-enabled for Library/Homebrew Style/FrozenStringLiteralComment: Enabled: false + +Style/Documentation: + Enabled: false + Metrics/BlockLength: Enabled: false diff --git a/Library/Homebrew/.rubocop.yml b/Library/Homebrew/.rubocop.yml index d517069b811461d945654e4b5372abbc80bd0fdc..e280f0f62facb5d168872acdadfd5713f62a31b6 100644 --- a/Library/Homebrew/.rubocop.yml +++ b/Library/Homebrew/.rubocop.yml @@ -1,4 +1,6 @@ -inherit_from: ../.rubocop_rspec.yml +inherit_from: + - ../.rubocop_rspec.yml + - .rubocop_todo.yml AllCops: Include: @@ -105,12 +107,6 @@ Naming/MethodParameterName: Style/AccessModifierDeclarations: Enabled: false -# make rspec formatting more flexible -Style/BlockDelimiters: - Exclude: - - '**/*_spec.rb' - - '**/shared_examples/**/*.rb' - # don't group nicely documented or private attr_readers Style/AccessorGrouping: Exclude: @@ -121,11 +117,16 @@ Style/AccessorGrouping: - 'system_command.rb' - 'tap.rb' +# make rspec formatting more flexible +Style/BlockDelimiters: + Exclude: + - '**/*_spec.rb' + - '**/shared_examples/**/*.rb' + # document our public APIs Style/Documentation: Enabled: true - Include: - - 'formula.rb' + Style/DocumentationMethod: Enabled: true Include: diff --git a/Library/Homebrew/.rubocop_todo.yml b/Library/Homebrew/.rubocop_todo.yml new file mode 100644 index 0000000000000000000000000000000000000000..a74f62002a71a8ddb995d26af0759c81d61ba1cf --- /dev/null +++ b/Library/Homebrew/.rubocop_todo.yml @@ -0,0 +1,31 @@ +Style/Documentation: + Exclude: + - 'compat/**/*.rb' + - 'extend/**/*.rb' + - 'cmd/**/*.rb' + - 'dev-cmd/**/*.rb' + - 'test/**/*.rb' + - 'cask/macos.rb' + - 'cli/args.rb' + - 'cli/parser.rb' + - 'download_strategy.rb' + - 'global.rb' + - 'keg_relocate.rb' + - 'os/linux/global.rb' + - 'os/mac/architecture_list.rb' + - 'os/mac/keg.rb' + - 'reinstall.rb' + - 'software_spec.rb' + - 'upgrade.rb' + - 'utils.rb' + - 'utils/fork.rb' + - 'utils/gems.rb' + - 'utils/notability.rb' + - 'utils/popen.rb' + - 'utils/pypi.rb' + - 'utils/shebang.rb' + - 'utils/shell.rb' + - 'utils/spdx.rb' + - 'utils/livecheck_formula.rb' + - 'utils/repology.rb' + - 'version.rb'