Make the error message for an invalid version more user-friendly#942
Merged
allevato merged 1 commit intoswiftlang:mainfrom Feb 24, 2025
Merged
Conversation
TTOzzi
requested review from
ahoppen,
allevato,
bnbarham and
shawnhyam
as code owners
TTOzzi
force-pushed
the
configuration_decoding_error
branch
2 times, most recently
from
dd360f9 to
b3cc76c
Compare
allevato
reviewed
Feb 24, 2025
| /// with the previous format. | ||
| internal let highestSupportedConfigurationVersion = 1 | ||
|
|
||
| private struct ConfigurationDecodingError: LocalizedError { |
Member
There was a problem hiding this comment.
Instead of introducing a new error type, can you add this as a new case to https://github.com/swiftlang/swift-format/blob/main/Sources/SwiftFormat/API/SwiftFormatError.swift? Something like unsupportedConfigurationVersion(Int, highestSupported: Int).
You'll need to add it as an allowed API breakage to https://github.com/swiftlang/swift-format/blob/main/api-breakages.txt, but that's fine because swift-format doesn't promise a resilient API.
Member
Author
There was a problem hiding this comment.
Oh there's already an error type defined! Thanks for the feedback.
TTOzzi
force-pushed
the
configuration_decoding_error
branch
from
b3cc76c to
5773d64
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The error message displayed when an invalid version is entered in the
.swift-formatconfiguration was not user-friendly.Currently, only version 1 exists, but in preparation for the possibility of more versions being introduced in the future (such as #833..?), I improved the message to help users easily identify and correct invalid version inputs.
Additionally, I modified the error message to display the path using
relativePath.Below is the output when setting the version in the configuration file to 2.
before:
after:
