[Feature Request] Self-Documenting? about envconfig HOT 4 CLOSED

What do you mean by self-documenting? Sorry, I'm not familiar with spf13/cobra.

We do have the Usage/Usaget/Usagef family of functions for dumping out info about the supported environment variables. Does that qualify?

from envconfig.

For the record, here is an example (I use it on a personal project):

import (
	"bytes"
	"io"
	"text/tabwriter"

	"github.com/kelseyhightower/envconfig"
)

const (
	mdFormat = `| KEY	| TYPE	| DEFAULT	| REQUIRED	| DESCRIPTION	|
| 	| 	| 	| 	| 	|
{{range .}}| {{ usage_key . }}	| {{usage_type .}}	| {{usage_default .}}	| {{usage_required .}}	| {{usage_description .}}	|
{{end}}`
)

func Usage(prefix string, spec interface{}, output io.Writer) {
	var b bytes.Buffer
	tabs := tabwriter.NewWriter(&b, 1, 0, 4, ' ', 0)
	envconfig.Usagef(prefix, spec, tabs, mdFormat)
	tabs.Flush()
	// replace the second line's spaces by dash
	bytes := b.Bytes()
	lines := 0
	for i, b := range bytes {
		if b == '\n' {
			lines++
		}
		if lines == 1 && b == ' ' {
			bytes[i] = '-'
		}
	}
	io.Copy(output, &b)
}

from envconfig.

Thanks, @owulveryck, I needed the output in AsciiDoc format instead of markdown and your snippet was very useful, since I only had to adapt the mdFormat variable. If anybody else is interested, here's the corresponding template to render an AsciiDoc Table:

adocFormat := `
[%header,cols="1,1,1,1,2"]
|===
| KEY	| TYPE	| DEFAULT	| REQUIRED	| DESCRIPTION	
{{range .}}| {{ usage_key . }}	| {{usage_type .}}	| {{usage_default .}}	| {{usage_required .}}	| {{usage_description .}}	
{{end}}|===
`

from envconfig.

Usage was what I was looking for! My goal is to generate an output similar to the one shown here. I should be able to generate the markdown somewhere in my CI/CD pipeline with help from Usagef(), I should've checked the GoDoc first, thanks.

from envconfig.