31 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
Bo Anderson
b2e837f94d
rubocops/shared/desc_helper: fix autocorrect infinite loop 2024-05-21 23:55:26 +01:00
Markus Reiter
0f0055ede4
Make documentation @api private by default. 2024-04-26 19:04:20 +02:00
Mike McQuaid
ea2892f8ee
brew.rb: handle missing args. 2024-03-07 16:20:20 +00:00
Razvan Azamfirei
c355723fe5
fix desc auto-correct order 2023-06-20 11:36:47 -04:00
Razvan Azamfirei
a3ee3650cb
Update Library/Homebrew/rubocops/shared/desc_helper.rb
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-06-20 11:24:35 -04:00
Razvan Azamfirei
c1009247bf
Apply suggestions from code review
Co-authored-by: FX Coudert <fxcoudert@gmail.com>
2023-06-20 08:59:01 -04:00
Razvan Azamfirei
adf6278e3c
rubocops: add emoji audit 2023-06-20 08:10:38 -04:00
Issy Long
0c2e6e59c5
rubocop: Remove redundant Style/InverseMethods disables 2023-04-07 21:35:38 +01:00
Douglas Eichelberger
71402a9a41 Disable false positive violation 2023-03-02 11:49:09 -08:00
Douglas Eichelberger
6c93f6fe91 Enable typing in rubocops 2023-02-16 15:51:20 -08:00
Bo Anderson
450bc4ab33
Fix brew style 2021-03-26 14:11:03 +00:00
nandahkrishna
8e5451df2f
style: use parentheses for assignment in conditions 2021-02-12 18:33:37 +05:30
Jonathan Chang
23b8d0ccb8 rubocops/desc: use rubocop v1 API 2021-01-12 19:16:38 +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
Jonathan Chang
f6cd7b72f4
Merge pull request #8757 from reitermarkus/desc-the
Check for descriptions starting with “the”.
2020-09-20 15:36:27 +10:00
Markus Reiter
78cd6dc0a9 Allow “macOS virtual machines” in descriptions. 2020-09-19 04:30:54 +02:00
Markus Reiter
9a48568226 Check for descriptions starting with “the”. 2020-09-17 20:44:09 +02:00
Mike McQuaid
8b97c27c21 brew style manual fixes 2020-09-01 14:26:45 +01:00
Markus Reiter
f32b2e0515
Switch unless to if.
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2020-09-01 13:59:24 +02:00
Markus Reiter
6994556d19 Don't allow platform in cask descriptions. 2020-09-01 13:18:59 +02:00
Markus Reiter
3038ff8726 Improve detection of descriptions starting with cask/formula name. 2020-09-01 02:53:25 +02:00
Markus Reiter
d5ba5cb8f8 Document rubocops/shared modules. 2020-08-26 03:13:59 +02:00
Markus Reiter
750e299d49 Don't take name into account when calculating description length. 2020-08-15 00:16:56 +02:00
Markus Reiter
62ae16bfa8 Allow iOS and iPhone at the beginning of descriptions. 2020-08-13 18:18:03 +02:00
Markus Reiter
9ed16681f3 Fix Desc cop for casks. 2020-08-12 01:07:03 +02:00
Waldir Pimenta
fc6813f094 Extract formula desc auditing code to a separate module
The extracted module will be used for Cask descs as well.

Co-authored-by: Markus Reiter <me@reitermark.us>
2020-08-08 23:02:39 +01:00