This repository has been archived by the owner on Aug 31, 2023. It is now read-only.
feat(rome_analyze): improve the diagnostics builder in the analyzer #2692
Conversation
This file contains 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
Deploying with
|
| Latest commit: |
bd9d8fd
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fdbeb41e.tools-8rn.pages.dev |
| Branch Preview URL: | https://feature-analyzer-diagnostic-.tools-8rn.pages.dev |
leops
force-pushed
the
feature/analyzer-diagnostic-builder
branch
from
ba7c79d
to
bdd68e4
Compare
leops
changed the title
MichaReiser
approved these changes
Jun 10, 2022
ematipico
reviewed
Jun 10, 2022
leops
force-pushed
the
feature/analyzer-diagnostic-builder
branch
from
03d25e6
to
bd9d8fd
Compare
ematipico
approved these changes
Jun 13, 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
This PR replicates the builder pattern implemented on
rome_diagnostic::Diagnosticfor theRuleDiagnostictype used internally by the analyzer rules. It should expose all the capabilities of normal diagnostics (including multiple labels and footers) with the notable exception of:file_id: at the moment diagnostics are considered to belong to the file currently being analyzedcode: this property has its value set to the name of the rule that emitted the diagnosticsuggestions: rules that emit quick fix suggestions are expected to do so by emitting a code actionAdditionally, it adds a new optional
summaryfield to diagnostics containing a plain-text description of the issue, aimed at rendering contexts that don't support rich formatting (such as diagnostic popovers in editors)Test Plan
Existing rules have been modified to use the new methods, and snapshots were updated accordingly