This repository has been archived by the owner on Aug 31, 2023. It is now read-only.
fix(rome_fs): improve the messaging of the "unhandled file type" diagnostic #3332
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 #3329
This PR changes the rendering of the
UnhandledDiagnostic
diagnostic type, emitted by theOsFileSystem
when an unknown file type is encountered. It adds an explicit error message and description, along with an information advices providing additional details. It also adds a specialized version of the error message when the unhandled file is a symbolic link, as that's the most common case for this error to be raised. Finally, it downgrades the severity of the diagnostic from error to warning, since this is not a "fatal" error that should cause the traversal to abort.The diagnostic should now be printed as follow when encountering a symbolic link:
In the less likely case that the CLI encounters a completely unknown file type, the following message is displayed instead:
Test Plan
This diagnostic is emitted by low-level code in response to an event from the underlying file system, so it's unfortunately hard to reliably test and reproduce across platforms.