brew/docs/.rubocop.yml

inherit_from: ../Library/.rubocop.yml

AllCops:
  Exclude:
  - Gemfile
  - ".mdl*.rb"
  - Rakefile
  - "_site/**/*"
  - Manpage.md

# 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
Teach `brew style` about `docs/.rubocop.yml` - Yes, we have yet another `.rubocop.yml` but in-line exclusions in `<span class="display:none;">` in the Markdown seemed more ugly. - This needed tweaks to `brew style` to make it read the new config file when we're scanning docs. 2024-01-23 23:06:04 +00:00			`inherit_from: ../Library/.rubocop.yml`

			`AllCops:`
			`Exclude:`
			`- Gemfile`
			`- ".mdl*.rb"`
			`- Rakefile`
			`- "_site/*/"`
Ignore the generated manpage; reinstate its trailing whitespace 2024-02-02 15:24:17 +00:00			`- Manpage.md`
Teach `brew style` about `docs/.rubocop.yml` - Yes, we have yet another `.rubocop.yml` but in-line exclusions in `<span class="display:none;">` in the Markdown seemed more ugly. - This needed tweaks to `brew style` to make it read the new config file when we're scanning docs. 2024-01-23 23:06:04 +00:00
			`# These are included in docs deliberately to show what`
			# `brew create` does and what the user should replace.
			`FormulaAudit/Comments:`
			`Enabled: false`

Turn off `FormulaAudit/{Desc,Homepage}` for docs - We don't need this blanket enabled, we only have a few docs where it actually matters that there's a description, it's just cruft having to invent descriptions. 2024-02-02 15:37:01 +00:00			`# 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`

Teach `brew style` about `docs/.rubocop.yml` - Yes, we have yet another `.rubocop.yml` but in-line exclusions in `<span class="display:none;">` in the Markdown seemed more ugly. - This needed tweaks to `brew style` to make it read the new config file when we're scanning docs. 2024-01-23 23:06:04 +00:00			`Layout/LineLength:`
Allow a longer `Layout/LineLength` for just the bottle blocks 2024-01-27 12:32:46 +00:00			`Exclude:`
			`- Bottles.md # The bottle block line length is long in its full form.`
Teach `brew style` about `docs/.rubocop.yml` - Yes, we have yet another `.rubocop.yml` but in-line exclusions in `<span class="display:none;">` in the Markdown seemed more ugly. - This needed tweaks to `brew style` to make it read the new config file when we're scanning docs. 2024-01-23 23:06:04 +00:00
			`# 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`