update example

_example/cmd/cmd.go

@@ -28,13 +28,10 @@ type serverCmd struct {
 }
 
 func (s serverCmd) Run(app *kong.Context, g *Globals, l *zap.SugaredLogger, reg *prometheus.Registry) error {
-	l.Infow("starting server", king.FlagMap(app).Rm(
+	l.Infow("starting server", king.FlagMap(app, regexp.MustCompile("token"), regexp.MustCompile("pw")).Rm(
 		"help", "version",
 	).Register(
 		app.Model.Name, reg,
-	).Redact(
-		regexp.MustCompile("token"),
-		regexp.MustCompile("pw"),
 	).List()...)
 
 	r := chi.NewRouter()
@@ -59,8 +56,10 @@ func (s serverCmd) Run(app *kong.Context, g *Globals, l *zap.SugaredLogger, reg
 
 // Globals are the gloabal flags.
 type Globals struct {
-	Debug    bool          `help:"enable debug output"`
-	Profiler profilerFlags `embed:"" prefix:"profiler-"`
+	Debug    bool             `help:"enable debug output"`
+	Profiler profilerFlags    `embed:"" prefix:"profiler-"`
+	Version  king.VersionFlag `help:"Show version information"`
+	Show     king.ShowConfig  `help:"Show config file used"`
 }
 
 type profilerFlags struct {

_example/main.go

@@ -17,7 +17,7 @@ var (
 	commit  = "123456789"
 )
 
-const appName = "daeira"
+const appName = "example"
 
 func main() {
 	cli := cmd.CLI{}

config.go

@@ -18,9 +18,9 @@ const (
 type ShowConfig bool
 
 // BeforeApply is the actual show-config command.
-func (s ShowConfig) BeforeApply(k *kong.Kong, vars kong.Vars) error {
-	fmt.Fprintln(k.Stderr, "Configuration files:")
-	w := tabwriter.NewWriter(k.Stderr, 0, 0, 1, ' ', 0)
+func (s ShowConfig) BeforeApply(app *kong.Kong, vars kong.Vars) error {
+	fmt.Fprintln(app.Stderr, "Configuration files:")
+	w := tabwriter.NewWriter(app.Stderr, 0, 0, 1, ' ', 0)
 
 	for _, file := range Configs(vars) {
 		filePath := kong.ExpandPath(file)
@@ -35,6 +35,8 @@ func (s ShowConfig) BeforeApply(k *kong.Kong, vars kong.Vars) error {
 
 	w.Flush()
 
+	app.Exit(0)
+
 	return nil
 }
 

king.go

@@ -68,12 +68,18 @@ func DefaultOptions(c Config) []kong.Option {
 type Map map[string]interface{}
 
 // FlagMap returns the flags and corresponding values from *kong.Context.
-func FlagMap(ctx *kong.Context) Map {
+//
+// To prevent logging sensitive flag values it is possible to provide
+// a list of regular expressions. Flag values of flag names that match are
+// redacted by '*'.
+func FlagMap(ctx *kong.Context, redactFlags ...*regexp.Regexp) Map {
 	m := Map{}
 	for _, f := range ctx.Flags() {
 		m[f.Name] = ctx.FlagValue(f)
 	}
 
+	m = m.redact(redactFlags...)
+
 	b := newBuildInfo("king_", ctx.Model.Vars())
 	if b != nil {
 		m[buildInfoKey] = b
@@ -85,9 +91,8 @@ func FlagMap(ctx *kong.Context) Map {
 	return m
 }
 
-// Redact redacts values get with '*', for keys that match a keyRegexp
-// regular expression. This can be useful for redacting passwords, keys etc...
-func (m Map) Redact(keyRegexp ...*regexp.Regexp) Map {
+func (m Map) redact(keyRegexp ...*regexp.Regexp) Map {
+
 	r := redactor(keyRegexp)
 	nm := Map{}
 

king_test.go

@@ -197,7 +197,7 @@ func TestFlagMap(t *testing.T) {
 	ctx, err := parser.Parse([]string{"--help", "--override-config=will_be_redacted"})
 	require.NoError(t, err)
 
-	l := king.FlagMap(ctx).Rm("override-auto-env", "help").Add("version", "1.0", "commit", "123456789", "not_added").Redact(regexp.MustCompile("override-config")).List()
+	l := king.FlagMap(ctx, regexp.MustCompile("override-config")).Rm("override-auto-env", "help").Add("version", "1.0", "commit", "123456789", "not_added").List()
 	expected := []interface{}{
 		"commit",
 		"123456789",
@@ -217,7 +217,7 @@ func TestFlagMap(t *testing.T) {
 	assert.Equal(t, expected, l)
 
 	reg := prometheus.NewRegistry()
-	king.FlagMap(ctx).Add("pw", "123").Add("bool-flag", "true").Redact(regexp.MustCompile("pw")).Rm("help").Register("program", reg)
+	king.FlagMap(ctx, regexp.MustCompile("override-config")).Add("bool-flag", "true").Rm("help").Register("program", reg)
 
 	a, err := reg.Gather()
 	require.NoError(t, err)
@@ -236,11 +236,7 @@ func TestFlagMap(t *testing.T) {
 		`name:"name" value:"bool-flag"`,
 		`name:"program" value:"program"`,
 		`name:"value" value:"true"`,
-		`name:"name" value:"override-config"`,
-		`name:"program" value:"program"`,
-		`name:"value" value:"will_be_redacted"`,
 	}
-
 	sort.Strings(expectedLabels)
 	sort.Strings(labels)