Improve dep update error message #2901
Merged
Conversation
This file contains 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
Update the error message shown with 'buf dep update' if there are unused dependencies.
bufdev
reviewed
Apr 18, 2024
| @@ -92,8 +92,7 @@ func Prune( | |||
| switch t := malformedDep.Type(); t { | |||
| case bufworkspace.MalformedDepTypeUnused: | |||
| logger.Sugar().Warnf( | |||
| `Module %s is declared in your buf.yaml deps but is unused. This command only modifies buf.locks, not buf.yamls, please %s from your buf.yaml deps if it is not needed.`, | |||
| malformedDep.ModuleFullName(), | |||
| `Module %[1]s is declared in your buf.yaml deps but is unused. This command only modifies buf.lock files, not buf.yaml files. Please remove %[1]s from your buf.yaml deps if it is not needed.`, | |||
There was a problem hiding this comment.
What is it updating it to? Can you provide an example?
There was a problem hiding this comment.
Before:
$ buf dep update
WARN Module buf.build/protocolbuffers/wellknowntypes is declared in your buf.yaml deps but is unused. This command only modifies buf.locks, not buf.yamls, please buf.build/protocolbuffers/wellknowntypes from your buf.yaml deps if it is not needed.
After:
$ buf dep update
WARN Module buf.build/protocolbuffers/wellknowntypes is declared in your buf.yaml deps but is unused. This command only modifies buf.lock files, not buf.yaml files. Please remove buf.build/protocolbuffers/wellknowntypes from your buf.yaml deps if it is not needed.
The main change is to add remove after please.
bufdev
approved these changes
Apr 19, 2024
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.
Update the error message shown with 'buf dep update' if there are unused dependencies.