Commits on Aug 12, 2024

1. 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 #18018 (comment).
   
   - 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
   ```

   

   issyl0 committed Aug 12, 2024
   Configuration menu

   • View commit details
   • Copy full SHA for 4597843
   • Browse repository at this point

   Copy the full SHA

   4597843 View commit details

   Browse the repository at this point in the history