chore: deprecate environment modules, move to github.com/hasura/goenvconf (#208)

Author: hgiasac

utils/environment.go

@@ -15,12 +15,16 @@ var (
 )
 
 // EnvString represents either a literal string or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvString struct {
 	Value    *string `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvString creates an EnvString instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvString(env string, value string) EnvString {
 	return EnvString{
 		Variable: &env,
@@ -29,13 +33,17 @@ func NewEnvString(env string, value string) EnvString {
 }
 
 // NewEnvStringValue creates an EnvString with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvStringValue(value string) EnvString {
 	return EnvString{
 		Value: &value,
 	}
 }
 
 // NewEnvStringVariable creates an EnvString with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvStringVariable(name string) EnvString {
 	return EnvString{
 		Variable: &name,
@@ -61,6 +69,8 @@ func (ev *EnvString) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvString) Get() (string, error) {
 	if err := validateEnvironmentValue(ev.Value, ev.Variable); err != nil {
 		return "", err
@@ -88,6 +98,8 @@ func (ev EnvString) Get() (string, error) {
 }
 
 // GetOrDefault returns the default value if the environment value is empty.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvString) GetOrDefault(defaultValue string) (string, error) {
 	result, err := ev.Get()
 	if err != nil {
@@ -104,12 +116,16 @@ func (ev EnvString) GetOrDefault(defaultValue string) (string, error) {
 }
 
 // EnvInt represents either a literal integer or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvInt struct {
 	Value    *int64  `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvInt creates an EnvInt instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvInt(env string, value int64) EnvInt {
 	return EnvInt{
 		Variable: &env,
@@ -118,13 +134,17 @@ func NewEnvInt(env string, value int64) EnvInt {
 }
 
 // NewEnvIntValue creates an EnvInt with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvIntValue(value int64) EnvInt {
 	return EnvInt{
 		Value: &value,
 	}
 }
 
 // NewEnvIntVariable creates an EnvInt with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvIntVariable(name string) EnvInt {
 	return EnvInt{
 		Variable: &name,
@@ -150,6 +170,8 @@ func (ev *EnvInt) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvInt) Get() (int64, error) {
 	if err := validateEnvironmentValue(ev.Value, ev.Variable); err != nil {
 		return 0, err
@@ -170,6 +192,8 @@ func (ev EnvInt) Get() (int64, error) {
 }
 
 // GetOrDefault returns the default value if the environment value is empty.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvInt) GetOrDefault(defaultValue int64) (int64, error) {
 	result, err := ev.Get()
 	if err != nil {
@@ -184,12 +208,16 @@ func (ev EnvInt) GetOrDefault(defaultValue int64) (int64, error) {
 }
 
 // EnvBool represents either a literal boolean or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvBool struct {
 	Value    *bool   `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvBool creates an EnvBool instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvBool(env string, value bool) EnvBool {
 	return EnvBool{
 		Variable: &env,
@@ -198,13 +226,17 @@ func NewEnvBool(env string, value bool) EnvBool {
 }
 
 // NewEnvBoolValue creates an EnvBool with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvBoolValue(value bool) EnvBool {
 	return EnvBool{
 		Value: &value,
 	}
 }
 
 // NewEnvBoolVariable creates an EnvBool with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvBoolVariable(name string) EnvBool {
 	return EnvBool{
 		Variable: &name,
@@ -230,6 +262,8 @@ func (ev *EnvBool) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvBool) Get() (bool, error) {
 	if err := validateEnvironmentValue(ev.Value, ev.Variable); err != nil {
 		return false, err
@@ -250,6 +284,8 @@ func (ev EnvBool) Get() (bool, error) {
 }
 
 // GetOrDefault returns the default value if the environment value is empty.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvBool) GetOrDefault(defaultValue bool) (bool, error) {
 	result, err := ev.Get()
 	if err != nil {
@@ -264,12 +300,16 @@ func (ev EnvBool) GetOrDefault(defaultValue bool) (bool, error) {
 }
 
 // EnvFloat represents either a literal floating point number or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvFloat struct {
 	Value    *float64 `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string  `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvFloat creates an EnvFloat instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvFloat(env string, value float64) EnvFloat {
 	return EnvFloat{
 		Variable: &env,
@@ -278,13 +318,17 @@ func NewEnvFloat(env string, value float64) EnvFloat {
 }
 
 // NewEnvFloatValue creates an EnvFloat with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvFloatValue(value float64) EnvFloat {
 	return EnvFloat{
 		Value: &value,
 	}
 }
 
 // NewEnvFloatVariable creates an EnvFloat with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvFloatVariable(name string) EnvFloat {
 	return EnvFloat{
 		Variable: &name,
@@ -310,6 +354,8 @@ func (ev *EnvFloat) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvFloat) Get() (float64, error) {
 	if err := validateEnvironmentValue(ev.Value, ev.Variable); err != nil {
 		return 0, err
@@ -330,6 +376,8 @@ func (ev EnvFloat) Get() (float64, error) {
 }
 
 // GetOrDefault returns the default value if the environment value is empty.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvFloat) GetOrDefault(defaultValue float64) (float64, error) {
 	result, err := ev.Get()
 	if err != nil {
@@ -364,12 +412,16 @@ func validateEnvironmentMapValue(variable *string) error {
 }
 
 // EnvMapString represents either a literal string map or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvMapString struct {
 	Value    map[string]string `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string           `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvMapString creates an EnvMapString instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapString(env string, value map[string]string) EnvMapString {
 	return EnvMapString{
 		Variable: &env,
@@ -378,13 +430,17 @@ func NewEnvMapString(env string, value map[string]string) EnvMapString {
 }
 
 // NewEnvMapStringValue creates an EnvMapString with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapStringValue(value map[string]string) EnvMapString {
 	return EnvMapString{
 		Value: value,
 	}
 }
 
 // NewEnvMapStringVariable creates an EnvMapString with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapStringVariable(name string) EnvMapString {
 	return EnvMapString{
 		Variable: &name,
@@ -410,6 +466,8 @@ func (ev *EnvMapString) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvMapString) Get() (map[string]string, error) {
 	if err := validateEnvironmentMapValue(ev.Variable); err != nil {
 		return nil, err
@@ -426,12 +484,16 @@ func (ev EnvMapString) Get() (map[string]string, error) {
 }
 
 // EnvMapInt represents either a literal int map or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvMapInt struct {
 	Value    map[string]int64 `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string          `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvMapInt creates an EnvMapInt instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapInt(env string, value map[string]int64) EnvMapInt {
 	return EnvMapInt{
 		Variable: &env,
@@ -440,13 +502,17 @@ func NewEnvMapInt(env string, value map[string]int64) EnvMapInt {
 }
 
 // NewEnvMapIntValue creates an EnvMapInt with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapIntValue(value map[string]int64) EnvMapInt {
 	return EnvMapInt{
 		Value: value,
 	}
 }
 
 // NewEnvMapIntVariable creates an EnvMapInt with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapIntVariable(name string) EnvMapInt {
 	return EnvMapInt{
 		Variable: &name,
@@ -472,6 +538,8 @@ func (ev *EnvMapInt) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvMapInt) Get() (map[string]int64, error) {
 	if err := validateEnvironmentMapValue(ev.Variable); err != nil {
 		return nil, err
@@ -488,12 +556,16 @@ func (ev EnvMapInt) Get() (map[string]int64, error) {
 }
 
 // EnvMapFloat represents either a literal float map or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvMapFloat struct {
 	Value    map[string]float64 `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string            `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvMapFloat creates an EnvMapFloat instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapFloat(env string, value map[string]float64) EnvMapFloat {
 	return EnvMapFloat{
 		Variable: &env,
@@ -502,13 +574,17 @@ func NewEnvMapFloat(env string, value map[string]float64) EnvMapFloat {
 }
 
 // NewEnvMapFloatValue creates an EnvMapFloat with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapFloatValue(value map[string]float64) EnvMapFloat {
 	return EnvMapFloat{
 		Value: value,
 	}
 }
 
 // NewEnvMapFloatVariable creates an EnvMapFloat with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapFloatVariable(name string) EnvMapFloat {
 	return EnvMapFloat{
 		Variable: &name,
@@ -534,6 +610,8 @@ func (ev *EnvMapFloat) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvMapFloat) Get() (map[string]float64, error) {
 	if err := validateEnvironmentMapValue(ev.Variable); err != nil {
 		return nil, err
@@ -550,12 +628,16 @@ func (ev EnvMapFloat) Get() (map[string]float64, error) {
 }
 
 // EnvMapBool represents either a literal bool map or an environment reference.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 type EnvMapBool struct {
 	Value    map[string]bool `json:"value,omitempty" jsonschema:"anyof_required=value" mapstructure:"value" yaml:"value,omitempty"`
 	Variable *string         `json:"env,omitempty"   jsonschema:"anyof_required=env"   mapstructure:"env"   yaml:"env,omitempty"`
 }
 
 // NewEnvMapBool creates an EnvMapBool instance.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapBool(env string, value map[string]bool) EnvMapBool {
 	return EnvMapBool{
 		Variable: &env,
@@ -564,13 +646,17 @@ func NewEnvMapBool(env string, value map[string]bool) EnvMapBool {
 }
 
 // NewEnvMapBoolValue creates an EnvMapBool with a literal value.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapBoolValue(value map[string]bool) EnvMapBool {
 	return EnvMapBool{
 		Value: value,
 	}
 }
 
 // NewEnvMapBoolVariable creates an EnvMapBool with a variable name.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func NewEnvMapBoolVariable(name string) EnvMapBool {
 	return EnvMapBool{
 		Variable: &name,
@@ -596,6 +682,8 @@ func (ev *EnvMapBool) UnmarshalJSON(b []byte) error {
 }
 
 // Get gets literal value or from system environment.
+//
+// Deprecated: this module was moved to github.com/hasura/goenvconf.
 func (ev EnvMapBool) Get() (map[string]bool, error) {
 	if err := validateEnvironmentMapValue(ev.Variable); err != nil {
 		return nil, err