This repository was archived by the owner on Aug 31, 2023. It is now read-only.
feat(rome_js_analyze): Improve generated suppression text #3924
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
The suppression code action used to insert a suppression comment with the *reason* `suppressed`. The issue with `suppressed` is that users might think that this is the exact syntax necessary for suppression comments rather than it being a placeholder for the reason why the rule is suppressed. This PR changes the inserted suppression: ``` //·rome-ignore·lint/a11y/useKeyWithClickEvents:·<explanation> ``` which hopefully makes it clear to users that they should replace `<explanation>` with a reason. A more involved solution could select the `<explanation>` after adding the suppression comment. ## Test Plan See updated snapshots
✅ Deploy Preview for docs-rometools canceled.
|
ematipico
approved these changes
Dec 2, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The suppression code action used to insert a suppression comment with the reason
suppressed. The issue withsuppressedis that users might think that this is the exact syntax necessary for suppression comments rather than it being a placeholder for the reason why the rule is suppressed.This PR changes the inserted suppression:
which hopefully makes it clear to users that they should replace
<explanation>with a reason.A more involved solution could select the
<explanation>after adding the suppression comment.Test Plan
See updated snapshots