brew/docs/.rubocop.yml

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

# Formulae and Casks no longer use `rm_f`/`rm_rf`, so the docs need to match.
Lint/NonAtomicFileOperation:
  Enabled: false

# The markdown linter config files don't need to be typed strict.
Sorbet/StrictSigil:
  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:`
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			`- "/_site//*"`
			`- "**/Manpage.md"`
			`- "/vendor//*"`
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:`
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			`- "**/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`
docs: fix `brew style` 2024-06-12 19:17:17 +01:00
			`# Want to be able to display partial formulae in the docs.`
			`Style/TopLevelMethodDefinition:`
			`Enabled: false`
Formula-Cookbook: Stop recommending `rm_f` in `postinstall` - After all the work that went into https://github.com/Homebrew/brew/pull/17705, we don't want the docs disagreeing with what CI says the style should be. 2024-08-04 23:57:49 +01:00
			# Formulae and Casks no longer use `rm_f`/`rm_rf`, so the docs need to match.
			`Lint/NonAtomicFileOperation:`
			`Enabled: false`
rubocop: Use `Sorbet/StrictSigil` as it's better than comments - Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' \| wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ``` 2024-08-12 10:30:59 +01:00
			`# The markdown linter config files don't need to be typed strict.`
			`Sorbet/StrictSigil:`
			`Enabled: false`