Add all deprecate! and disable! arguments to the formula API
#21214
Conversation
This file contains hidden or 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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds deprecate_args and disable_args fields to the Formula class to capture all arguments passed to deprecate! and disable! methods, regardless of whether the deprecation/disable is currently active. This enables the API to replicate the exact method calls used in formula files, supporting a follow-up PR that will handle API generation with these new fields.
- Adds
@deprecate_argsand@disable_argsinstance variables to store the full argument hashes - Exposes these arguments through delegate methods and includes them in the
to_hashoutput - Includes a minor typo fix in the
disable!deprecation message - Removes unnecessary
T.mustwrapper in thedeprecate!method
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Library/Homebrew/sorbet/rbi/dsl/formula.rbi | Adds Sorbet type signatures for new deprecate_args and disable_args methods |
| Library/Homebrew/formula.rb | Implements storage and delegation of deprecation/disable arguments, adds them to API hash output, includes minor code cleanup |
Files not reviewed (1)
- Library/Homebrew/sorbet/rbi/dsl/formula.rbi: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1384a35 to
75c9bf7
Compare
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.
I noticed that we don't include all of the
deprecateanddisable!arguments in the formula API, we only include them if the deprecation/disable date is active (i.e. before today).This PR adds
deprecate_argsanddisable_argsfields to the API that contain all of the arguments passed todeprecate!anddisable!, regardless of whether the deprecation/disable is active. This will allow the API to replicate the exactdeprecate!/disable!call that is used in the formula file. I have a follow-up PR ready to handle this once this change is merged and makes it through the API generation.