Description of configs about aconfig HOT 3 CLOSED

Yep, one more expected issue feature :D

Completely agree, I also was looking for comment as a doc solution, but it's not possible without full code parsing (also imagine, when config consists of different structs from different packages or even modules). Even with an explicit go:generate it will be plenty of thing to do which is probably out of scope for this lib.

But! there is already a constant (https://github.com/cristalhq/aconfig/blob/master/aconfig.go#L20) which is planed to be used as a field description. Treat it as work in progress.

I haven't implemented it yet, 'cause was looking for a solution when user can generate it's own documentation for the config. Maybe:

loader.WalkFields(func(f *aconfig.Field) {
	_ = f.Name() // also env, flag names
	_ = f.DefaultValue()
	_ = f.Usage()
	_ = f.Parent() // probably of `aconfig.Field` type
	// and now user can pass this values to some kind of template and generate whatever it's possible
})

Probably it's ok to start with a simple one (add usage or description tag) and wait for a feedback.

from aconfig.

Awesome, usage works like expected!

loader.WalkFields looks pretty good. I'd like to also extract yaml tag and I see that TOML uses toml tag, so maybe add f.Tag(String) to aconfig.Field?

from aconfig.

Agree, limiting to aconfig-known tags is strange, common f.Tag(string) string methods will be much better.

from aconfig.