summaryrefslogtreecommitdiff
path: root/main.go
blob: 84dedb5e94df58ac9bfa9dd01ed7cb90866f9971 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// Package envflag is an extremely small bit of code to make configuration
// via environment variables a little bit less of a hassle when using
// the flag package in the standard library.
//
// Example:
//
//	package main
//
//	import (
//		"flag"
//		"fmt"
//		"os"
//
//		"riedstra.dev/go/envflag"
//	)
//
//	func main() {
//		fl := flag.NewFlagSet("envflag", flag.ExitOnError)
//
//		var aFlag string = "some default"
//		fmt.Println("aFlag:", aFlag)
//
//		envflag.String(fl, &aFlag, "a", "FLAG_A", "Set's the value of -a")
//
//		// By default, command line flags override environment vars.
//		fl.Parse(os.Args[1:])
//
//		fmt.Println("aFlag:", aFlag)
//	}
//
// Known caveat, variables set in the environment will override what the flag
// package sees as the "default" value.
package envflag

import (
	"flag"
	"fmt"
	"os"
	"strconv"
)

// String is a convent way to set value from environment variable,
// and allow override when a command line flag is set. It's assumed `p` is
// not nil.
func String(fl *flag.FlagSet, p *string, name, envvar, usage string) {
	if v := os.Getenv(envvar); v != "" {
		*p = v
	}

	fl.StringVar(p, name, *p, fmt.Sprintf("%s (Environ: '%s')", usage, envvar))
}

// Bool is a convent way to set value from environment variable,
// and allow override when a command line flag is set. It's assumed `p` is
// not nil.
func Bool(fl *flag.FlagSet, p *bool, name, envvar, usage string) error {
	if v := os.Getenv(envvar); v != "" {
		res, err := strconv.ParseBool(v)

		if err != nil {
			return fmt.Errorf("Bool: cannot parse '%s=%s', %w",
				envvar, v, err)
		}

		*p = res
	}

	fl.BoolVar(p, name, *p, fmt.Sprintf("%s (Environ: '%s')", usage, envvar))

	return nil
}

// Int is a convent way to set value from environment variable,
// and allow override when a command line flag is set. It's assumed `p` is
// not nil.
func Int(fl *flag.FlagSet, p *int, name, envvar, usage string) error {
	if v := os.Getenv(envvar); v != "" {
		res, err := strconv.ParseInt(v, 10, 32)
		if err != nil {
			return fmt.Errorf("Int: cannot parse '%s=%s', %w",
				envvar, v, err)
		}

		*p = int(res)
	}

	fl.IntVar(p, name, *p, fmt.Sprintf("%s (Environ: '%s')", usage, envvar))

	return nil
}