This repository has been archived by the owner on Aug 31, 2023. It is now read-only.
fix(rome_cli): do not print lint warnings for the format command #2680
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
MichaReiser
approved these changes
Jun 8, 2022
Comment on lines
+97
to
+100
| let diagnostics = self.workspace.pull_diagnostics(PullDiagnosticsParams { | ||
| path: rome_path, | ||
| categories: RuleCategories::SYNTAX | RuleCategories::LINT, | ||
| })?; |
There was a problem hiding this comment.
Nit: What do you think of having a new function that only accepts the path and defaults the categories to all categories and a method with_categories that changes the categories to the specified categories?
There was a problem hiding this comment.
For now I think it's alright to explicitly set all parameters while there are only a few of them, but it would make sense to introduce such a builder pattern if these methods need additional options (and they probably will as the analyzer starts getting more features)
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 fixes #2670 by skipping the printing of diagnostics in traversal operations for the
formatcommands if no errors were returned bypull_diagnosticsAdditionally, I exposed the
categoriesfilter fromrome_analyzeto consumers of thepull_diagnosticsmethod to let clients chose which diagnostics categories they want: in format mode this is used to only run rules with theSYNTAXcategory and ignoreLINTrules, to avoid emitting diagnostics that would not impact the correctness of formatting in the first placeTest Plan
I added an additional
lint_warningtest to the CLI verifying no warnings are printed to the console when formatting files with lint errors