This repository was archived by the owner on Aug 31, 2023. It is now read-only.
feat(rome_service): add a max_diagnostics parameter to pull_diagnostics
#3512
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 rometools ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
ematipico
approved these changes
Oct 27, 2022
| if let Some(mut diagnostic) = signal.diagnostic() { | ||
| diagnostic_count += 1; |
There was a problem hiding this comment.
Just a note for the future, but I think it's fine for now. We are grouping diagnostics regardless of their severity, which means that:
- errors and warnings are treated the same
- the CLI won't show many errors and warnings were encountered/skipped/not shown
There was a problem hiding this comment.
The workspace command could very easily expose individual skipped_errors / skipped_warnings / ... counters for each severity level if needed
0bb94bd to
7ded49d
Compare
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 adds a new
max_diagnosticsfield toPullDiagnosticsParamsthat limits how many diagnostics are emitted in thediagnosticsfield ofPullDiagnosticsResult, and maintains a counter ofskipped_diagnosticsas well as anhas_errorsflag to allow checking if any of the skipped diagnostics had a severity ofErroror higher. Themax_diagnosticsvalue is not a hard limit, and more diagnostics may be emitted by the parser. This new argument is used in the CLI since it's only printing a limited amount of diagnostics, the console thread now maintains an approximate counter ofremaining_diagnosticsthat can still be printed, and the shared value of this counter is used as the value ofmax_diagnosticsin the worker threads of the traversal.Test Plan
This change is covered by the test suite of the CLI, none of the snapshots have been modified since it should be an internal change only.