env: add a 'translate_key' field to ease dealing with kebab-case #380
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
This allows usage of `kebab-case` attribute in serde, allowing
to mapping unambiguously into a config value given a multiple
character separator.
let environment = Environment::default()
.prefix("PREFIX")
.translate_key(TranslationType::Kebab)
.separator("__");
matthiasbeyer
requested changes
Sep 29, 2022
Comment on lines
+8
to
+11
| /// An environment source collects a dictionary of environment variables values into a hierarchical | ||
| /// config Value type. We have to be aware how the config tree is created from the environment | ||
| /// dictionary, therefore we are mindful about prefixes for the environment keys, level separators, | ||
| /// encoding form (kebab, snake case) etc. |
There was a problem hiding this comment.
Could you please split this to a seperate commit?
| @@ -77,6 +86,11 @@ pub struct Environment { | |||
| source: Option<Map<String, String>>, | |||
| } | |||
|
|
|||
| #[derive(Clone, Debug)] | |||
| pub enum TranslationType { | |||
| Kebab, // Translate '_' to '-' | |||
There was a problem hiding this comment.
Would it make sense to add more here?
There was a problem hiding this comment.
We can go even further, depending on convert_case crate and pass a convert_case::Case value here instead (eliminating TranslationType). If doing this, should we add a feature flag with optional dependency?
There was a problem hiding this comment.
That sounds good, IMO. Yes, a feature flag would be nice!
Comment on lines
+224
to
+230
| if let Some(translate_key) = translate_key { | ||
| match translate_key { | ||
| TranslationType::Kebab => { | ||
| key = key.replace("_", "-"); | ||
| }, | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| if let Some(translate_key) = translate_key { | |
| match translate_key { | |
| TranslationType::Kebab => { | |
| key = key.replace("_", "-"); | |
| }, | |
| } | |
| } | |
| if let Some(TranslationType::Kebab) = translate_key { | |
| key = key.replace("_", "-"); | |
| } |
But if we add more types then this is not possible of course. 😆
|
@matthiasbeyer, all requested done in another PR to fix branch name mixup. Here: #381 |
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.
This allows usage of
kebab-caseattribute in serde, allowing to mapping unambiguously into a config value given a multiple character separator.