dtanner / env-override Goto Github PK

• sample project
• guice example
• spring example?

e.g. @RequiresOverride

where it'll blow up if a property isn't overridden. maybe allow it at the class level and have an opposite annotation like @GlobalConfig that will let it be constant across envs.

Some users have been tripped up by the RequiresOverride annotation when they're in their dev environment, and aren't aware that you can disable it. Add a hint to the logs when halting the app on how to disable the check.

fun <T> T.withEnvOverrides(prefix: String, defaults: (T.() -> Unit)? = null): T {
    val config = this

    defaults?.invoke(config)
    return EnvConfigLoader.overrideFromEnvironment(config, prefix)
}

sample usage:

val metricsConfig = MetricsConfig().withEnvOverrides("METRICS")
bind(MetricsConfig::class.java).toInstance(metricsConfig)

Maybe along with or instead of the java property name, include the expected environment variable name including the prefix. That's what the person is actually missing, and it'll help clarify which configuration they're referencing too.