ci: Encourage Sorbet # typed: strict in new code
#18018
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Let's make Sorbet strict mode the default for new files, where possible. - This adds a new GitHub Actions step in the test job, _before_ typechecking, which ensures that new Ruby files are Sorbet strictly typed. Tested with: ```shell [ci-check-new-files-srb-strict e9dc524ef6] test new files Date: Sun Aug 11 23:39:50 2024 +0100 4 files changed, 5 insertions(+) create mode 100644 Library/Homebrew/bad.rb create mode 100644 Library/Homebrew/forgot.rb create mode 100644 Library/Homebrew/good.rb create mode 100644 Library/Homebrew/should_not_care.yml $ bash sorbet_sigils.sh Add the Sorbet strict sigil (# typed: strict) to Library/Homebrew/bad.rb. Add the Sorbet strict sigil (# typed: strict) to Library/Homebrew/forgot.rb. ```
issyl0
changed the title
# typed: strict in new code
carlocab
approved these changes
Aug 12, 2024
|
|
||
| for file in ${new_files}; do | ||
| if ! grep -q '# typed: strict' "${file}"; then | ||
| echo "Add the Sorbet strict sigil ("# typed: strict") to ${file}." |
There was a problem hiding this comment.
Could make this an annotation that shows up at the first line of the file.
MikeMcQuaid
reviewed
Aug 12, 2024
There was a problem hiding this comment.
Thanks for the PR @issyl0, I like the idea! I think a cleaner/easier fix for this would be enable the Sorbet/StrictSigil (and possibly Sorbet/TrueSigil) RuboCop(s) and add disables for the relevant files that are lacking them.
Ahhh, that's the angle you were going for. Fair enough. Will do! (The issue said "new files" explicitly so I went this way.) |
|
@issyl0 Thanks and sorry for confusion! |
|
But wait, if we want to do this incrementally then I don't think the RuboCop's gonna work because that doesn't detect "new files" explicitly, and so every file will have a True/Strict offense? (Or a big long list of enable/disable on the True one, which is unsightly.) |
Yeh, the RuboCop pattern for this is to enable globally and explicitly ignore the old files with a
A disable is preferable if possible because RuboCop will complain if unnecessary but, yeh, if not: a long list of |
issyl0
added a commit
that referenced
this pull request
Aug 12, 2024
- 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. - 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 ```
7 tasks
issyl0
added a commit
that referenced
this pull request
Aug 12, 2024
- 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
added a commit
that referenced
this pull request
Aug 12, 2024
- 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 ```
ctaintor
pushed a commit
to ctaintor/brew
that referenced
this pull request
Sep 4, 2024
- 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 Homebrew#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 ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
brew stylewith your changes locally?brew typecheckwith your changes locally?brew testswith your changes locally?typed: strictin all (non-package) files in Homebrew organisation #17297, specifically the "good transition step" of "requiringtyped: stricton all new files".# typed: strict).Tested with: