chore: rename package to vermock/vermockgen #7
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
Prior to this change, this package had been given the same name as an other package which is already in widespread use within the community. This does not cause a problem per se, but it does lead to aliasing should a project choose use both or adopt one and migrate away from the other. This aliasing can lead to ambiguity when a naming convention isn't agreed upon. The problem can be even more difficult to diagnose when you consider multiple installed binaries with the same name. This change could recommend a naming convention to address such situations but we have decided to take the more drastic action of renaming the whole package while we are still pre-v1. This mean renaming the module, GitHub repository, the packages (root package, ./cmd/mockgen, ./internal/cmd/mockgen) and of course the README.
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.
Prior to this change, this package had been given the same name as an other package which is already in widespread use within the community. This does not cause a problem per se, but it does lead to aliasing should a project choose use both or adopt one and migrate away from the other. This aliasing can lead to ambiguity when a naming convention isn't agreed upon. The problem can be even more difficult to diagnose when you consider multiple installed binaries with the same name.
This change could recommend a naming convention to address such situations but we have decided to take the more drastic action of renaming the whole package while we are still pre-v1. This mean renaming the module, GitHub repository, the packages (root package, ./cmd/mockgen, ./internal/cmd/mockgen) and of course the README.