This repository was archived by the owner on Aug 31, 2023. It is now read-only.
feat(rome_analyze): emit syntax error diagnostics for suppression comments #3847
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
✅ Deploy Preview for docs-rometools ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Parser conformance results on ubuntu-latestjs/262
jsx/babel
symbols/microsoft
ts/babel
ts/microsoft
|
MichaReiser
approved these changes
Nov 28, 2022
| @@ -246,10 +249,11 @@ struct LineSuppression { | |||
| did_suppress_signal: bool, | |||
| } | |||
|
|
|||
| impl<'a, 'phase, L, Matcher, Break> PhaseRunner<'a, 'phase, L, Matcher, Break> | |||
| impl<'a, 'phase, L, Matcher, Break, Diag> PhaseRunner<'a, 'phase, L, Matcher, Break, Diag> | |||
There was a problem hiding this comment.
This is becoming a beat. Would it be possible to use the boxed diagnostics versions instead of adding another type of argument?
There was a problem hiding this comment.
Unfortunately it's not possible to use a boxed trait here as the diagnostics needs to implement Clone, since the clone() method returns an owned Self it cannot be represented by an unsized dyn Trait
e18ce14 to
5238ed1
Compare
ematipico
approved these changes
Nov 28, 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.
Summary
Fixes #3841
With the existing suppression comment parsing logic, any comment that failed to parse as a suppression was simply ignored by the analyzer and formatter. I've modified the signature of the suppression parser so that any comment line that starts with
rome-ignore(I've also changed this to be case insensitive and allow underscores soROME_IGNOREwould work too) is now detected as a suppression comment, and everything that comes after must parse correctly or a diagnostic will get emitted.I expect this change to improve the developer experience of using suppression comments since incorrectly written suppression will now emit an explicit syntax error instead of being silently ignored.
Test Plan
I've added additional tests for the newly introduced errors to both the suppression parser in
rome_js_syntaxand the overall analyzer infrastructure inrome_js_analyze