Adding recipe for adding comments to import statements #5884
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
steve-aom-elliott
added
enhancement
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
steve-aom-elliott
force-pushed
the
1378-add-comment-to-import
branch
from
39dd8aa to
453d17a
Compare
steve-aom-elliott
force-pushed
the
1378-add-comment-to-import
branch
from
453d17a to
de70673
Compare
timtebeek
approved these changes
Aug 11, 2025
… the first matching import found rather than all that match
steve-aom-elliott
force-pushed
the
1378-add-comment-to-import
branch
from
de70673 to
586b0d2
Compare
dcsekar
pushed a commit
to dcsekar/rewrite
that referenced
this pull request
Aug 18, 2025
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.
What's changed?
Added recipe to allow you to add a comment to an import or multiple imports depending on the pattern provided.
What's your motivation?
There are some scenarios where we're not going to be able to provide an adequate migration for the usage of a class (like
HttpParamsfor example, because it can be populated by any number of things and has been replaced with multiple different classes depending on the usage context). In these cases, we might want to add a comment to imports of the class with some helpful links on how they might be manually replaced instead.Checklist