Handle various out-of-bounds diagnostic ranges in default diagnostics formatter #947
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
|
@swift-ci please test |
2 tasks
Kyle-Ye
approved these changes
Jun 11, 2024
|
LGTM. Any plan to cherry-pick this back to release/6.0? |
Yes. I think it's safe and small enough for that. |
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
Jun 11, 2024
… formatter (swiftlang#947) * Clamp lines to highlight in a diagnostic to the source lines * Add test about highlight for in-bounds range of a line * Clamp diagnostic line highlight to the bounds of each source line rdar://129586253
d-ronnqvist
added a commit
that referenced
this pull request
Jun 12, 2024
2 tasks
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Bug/issue #, if applicable: #729
Summary
This improved the input validation of the default diagnostic formatter so that incorrectly created diagnostics with out-of-bounds range information won't cause a crash.
Dependencies
None.
Testing
Since this needs an incorrectly created diagnostic, it requires a bug that results in out-of-bounds diagnostics to test.
This comment includes a package that reproduces on such bug. Building it should no longer crash (although it will output a duplicate diagnostic, because that issue is not fixed in this PR).
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeededUpdated documentation if necessaryNot applicable