brew/docs/.rubocop.yml
Mike McQuaid a707c708c1
Fix/reenable brew style docs
- start running this check again
- check the `docs` basename correctly
- use a different name (to a symlink) for the docs rubocop
  configuration so that path relativity is done correctly:
  https://docs.rubocop.org/rubocop/configuration.html#path-relativity
- add more wildcards to fix docs rubocop exclusions
2024-06-13 12:31:47 +01:00

35 lines
967 B
YAML

inherit_from: ../Library/.rubocop.yml
AllCops:
Exclude:
- "**/_site/**/*"
- "**/Manpage.md"
- "**/vendor/**/*"
# These are included in docs deliberately to show what
# `brew create` does and what the user should replace.
FormulaAudit/Comments:
Enabled: false
# This forces us to use dummy descriptions/homepages in example formulae which we don't need to clutter the docs with.
FormulaAudit/Desc:
Enabled: false
FormulaAudit/Homepage:
Enabled: false
Layout/LineLength:
Exclude:
- "**/Bottles.md" # The bottle block line length is long in its full form.
# Apparently Casks are allowed to have constant definitions in blocks and we document this.
Lint/ConstantDefinitionInBlock:
Enabled: false
# A fake regexp is deliberately documented for `inreplace` in the Formula Cookbook.
Style/RedundantRegexpArgument:
Enabled: false
# Want to be able to display partial formulae in the docs.
Style/TopLevelMethodDefinition:
Enabled: false