18 Commits

Author SHA1 Message Date
Eric Knibbe
cd6777fc73
audits: quote and reword problem description text 2025-05-30 23:49:26 -04:00
Issy Long
0fc1eb534b
More Sorbet typed: strict RuboCops
- Some of these I bumped to `typed: strict`, some of them I added
  intermediary type signatures to some of the methods to make my life
  easier in the (near, hopefully) future.
- Turns out that RuboCop node matchers that end in `?`
  can return `nil` if they don't match anything, not `false`.
2025-02-08 23:38:12 +00:00
Issy Long
45978435e7
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 15:24:27 +01:00
Sam Ford
17b0493e18
Use struct for #audit_formula args
Adding type signatures to `#audit_formula` methods in formula cops
would lead to verbose, repetitive signatures across the existing ~63
instances. This reworks `#audit_formula` to use a `T::Struct` for its
arguments, which allows us to use a one-line signature for these
methods.
2024-07-08 12:22:25 -04:00
Markus Reiter
0f0055ede4
Make documentation @api private by default. 2024-04-26 19:04:20 +02:00
Douglas Eichelberger
387d2f859f Use exclude_from_registry instead 2023-02-20 18:14:47 -08:00
Douglas Eichelberger
d9db5e8825 Refactor FormulaCop as a mixin 2023-02-20 18:14:47 -08:00
Michka Popoff
38ae6e0c0d style: re-enable sha256 checks for bottle blocks
Follow up PR to #10450
2021-01-28 20:35:31 +01:00
Michka Popoff
b87c23bb7e style: do not fail on sha256 lines with cellar information
Fixes:
1-01-28T17:17:10.7152456Z [31m==>[0m [1m[31mFAILED[0m[0m
2021-01-28T17:17:10.7163169Z [36mFormula/dhall-json.rb[0m:14:12: [33mC[0m: sha256 should be 64 characters
2021-01-28T17:17:10.7175011Z     sha256 cellar: :any_skip_relocation, big_sur: "a1e0cb4f7e4a7e0994b43ecd783240356631d36655cfbf59a903cc3f6a799242"
2021-01-28T17:17:10.7176620Z            ^^^^^^
2021-01-28T17:17:10.7178131Z [36mFormula/dhall-json.rb[0m:14:15: [33mC[0m: sha256 contains invalid characters
2021-01-28T17:17:10.7179886Z     sha256 cellar: :any_skip_relocation, big_sur: "a1e0cb4f7e4a7e0994b43ecd783240356631d36655cfbf59a903cc3f6a799242"
2021-01-28T17:17:10.7181198Z               ^^
2021-01-28T17:17:10.7182390Z [36mFormula/dhall-json.rb[0m:15:12: [33mC[0m: sha256 should be 64 characters
2021-01-28T17:17:10.7183801Z     sha256 cellar: :any_skip_relocation, catalina: "050f219d8050cf46a54487e0cad414374a5d2b4a6422d1e2e2c7a682149c3afb"
2021-01-28T17:17:10.7184956Z            ^^^^^^
2021-01-28T17:17:10.7186016Z [36mFormula/dhall-json.rb[0m:15:15: [33mC[0m: sha256 contains invalid characters
2021-01-28T17:17:10.7187458Z     sha256 cellar: :any_skip_relocation, catalina: "050f219d8050cf46a54487e0cad414374a5d2b4a6422d1e2e2c7a682149c3afb"
2021-01-28T17:17:10.7188630Z               ^^
2021-01-28 18:27:21 +01:00
Jonathan Chang
9046d778e0 rubocops/checksum: use rubocop v1 API 2021-01-12 19:11:42 +11:00
Jonathan Chang
f81e89193e rubocops: update helpers for rubocop v1 API 2021-01-12 19:11:42 +11:00
EricFromCanada
3768b7a6e9 apidoc: update comment wording, punctuation, formatting 2020-11-06 00:21:02 -05:00
Markus Reiter
24ae318a3d Move type annotations into files. 2020-10-10 14:59:39 +02:00
Markus Reiter
924fc47f0f Document FormulaAudit::Checksum. 2020-08-26 03:13:59 +02:00
Mike McQuaid
36dbad3922
Add frozen_string_literal to all files. 2019-04-20 13:27:36 +09:00
EricFromCanada
fa6404e0f5 grammar fixes 2019-04-13 21:29:32 -04:00
Mike McQuaid
d64429a736
rubocop: enable Style/IfUnlessModifier. 2019-02-21 12:55:49 +00:00
Mike McQuaid
376eac2b8d
rubocops: rename files for consistency.
Make the filenames consistent with the class names.
2018-11-08 14:42:55 +00:00