cli: deprecate cli.StatusError direct field usage
#5738
Closed
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 exported
cli.StatusErrortype may be usedby some directly within their own projects, making it difficult to update the struct's fields.
This patch converts the exported
cli.StatusErrorto an interface instead, so that code wrapping the CLI would still be able to match the error and get the status code without exposing the fields.This is a breaking change for those relying on creating a
cli.StatusError{}and accessing the error's fields. For those usingerrors.As(err, &statusError)anderr.(cli.StatusError)will be able to continue using it without breakage.Users accessing the fields of
cli.StatusError{}.StatusCodewould need to use the newGetStatusCode()method.- What I did
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)