fix(derive): Avoid name collisions with users #2935
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
PR clap-rs#2751 highlighted a problem we have where the variable names we use could collide with users. Rather than parse out when or not to use special names, and worry about people keeping that up to date through refactors, I globally renamed all variables by adding a `__clap_` prefix, which looks like what serde does to solve this problem. I audited the result with `cargo expand`. I didn't add any tests because any tests would be reactionary and would give us a false sense of protection since any new code could hit this with anything we do. Our best route for naming is consistency so people are likely to notice and copy. Fixes clap-rs#2934
|
Because this is collision heavy, I'm going ahead and merging this. If there is iteration to be done, we can do it in another PR. bors r+ |
|
Build succeeded: |
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.
PR #2751 highlighted a problem we have where the variable names we use
could collide with users. Rather than parse out when or not to use
special names, and worry about people keeping that up to date through
refactors, I globally renamed all variables by adding a
__clap_prefix, which looks like what serde does to solve this problem.
I audited the result with
cargo expand. I didn't add any testsbecause any tests would be reactionary and would give us a false sense
of protection since any new code could hit this with anything we do.
Our best route for naming is consistency so people are likely to notice
and copy.
Fixes #2934