search

spf13 / viper

Go configuration with fangs
MIT License
26.47k stars 2.01k forks source link

Add CaseSensitiveKeys option #1673

Open travisnewhouse opened 9 months ago

travisnewhouse commented 9 months ago

Case-sensitive keys are one of the most request features of Viper. See #1014.

When reading configuration from sources with case-sensitive keys, such as YAML, TOML, and JSON, a user may wish to preserve the case of keys that appear in maps. For example, consider when the value of a setting is an (opaque) map with string keys that are case-sensitive. Ideally, if the map value is not going to be indexed by a Viper lookup key, then the map value should be treated as an opaque value by Viper, and its keys should not be modified.

Viper's default behavior is that keys are case-sensitive, and this behavior is implemented by converting all keys to lower-case. For users that wish to preserve the case of keys, this commit introduces an Option CaseSensitiveKeys() that can be used to configure Viper to use case-sensitive keys. When CaseSensitiveKeys is enabled, all keys retain the original case, and lookups become case-sensitive (except for lookups of values bound to environment variables).

The behavior of Viper could become hard to understand if a user could change the CaseSensitiveKeys setting after values have been stored. For this reason, the setting may only be set when creating a Viper instance, and it cannot be set on the "global" Viper. This merge request implements case-sensitive keys in a manner that respects the existing behavior of the "global" Viper, and gives users an option to create a Viper that uses case-sensitive keys behavior.

CLAassistant commented 9 months ago

CLA assistant check
All committers have signed the CLA.

github-actions[bot] commented 9 months ago

👋 Thanks for contributing to Viper! You are awesome! 🎉

A maintainer will take a look at your pull request shortly. 👀

In the meantime: We are working on Viper v2 and we would love to hear your thoughts about what you like or don't like about Viper, so we can improve or fix those issues.

⏰ If you have a couple minutes, please take some time and share your thoughts: https://forms.gle/R6faU74qPRPAzchZ9

📣 If you've already given us your feedback, you can still help by spreading the news, either by sharing the above link or telling people about this on Twitter:

https://twitter.com/sagikazarmark/status/1306904078967074816

Thank you! ❤️