Support suggested fixes for error and warning reporting (#2551)#2955
Closed
HMH-3080 wants to merge 1 commit into
Closed
Support suggested fixes for error and warning reporting (#2551)#2955HMH-3080 wants to merge 1 commit into
HMH-3080 wants to merge 1 commit into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Collaborator
|
Hi thank you for the PR! Your contribution is much appreciated, however, supporting suggested fixes is not a top priority at the moment and I'm not sure this design is quite what we need even though there are some good ideas here. I'm going to close this PR, but feel free to propose a design in the linked issue that we can iterate on. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #2551 — Support suggested fixes
Summary
Adds
KSPSuggestedFixto KSP so processors can suggest replacement code alongside error/warning messages. This enables IDE tools (IntelliJ/Android Studio) to offer Quick Fixes directly from KSP diagnostics, similar to how Android Lint works.Changes
New API (
:api)KSPSuggestedFix— newdata classcarryingreplacementTextand optionaldescriptionKSPLogger— added defaultwarn(message, symbol, fix)anderror(message, symbol, fix)overloads (backward compatible)Logger implementations
KspGradleLogger— overrideswarn/errorwith fix, prints as:w: [ksp] <message> -> Suggested Fix (<desc>): [<replacement>]CommandLineKSPLogger— same, writes toSystem.errwithWarning:/Error:prefixBug fix (
:kotlin-analysis-api)KotlinSymbolProcessing— logger wrapper was missing overrides for the newfixoverloads, sohasErrorwas never set when callinglogger.error(..., fix). Fixed by adding the missingerror/warnoverrides with properhasErrortracking.API signature (
:api)api.basewithcomponent1(),component2(),copy()forKSPSuggestedFixTests
KspGradleLoggerTest(4 tests) +CommandLineKSPLoggerTest(4 tests)SuggestedFixProcessor+suggestedFix.kttest data — validates the full pipeline (processor → logger → exit code)Usage example
env.logger.error( "This annotation is deprecated", declaration, KSPSuggestedFix("@NewAnnotation", "Replace with @NewAnnotation") )