Comments (3)
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.
Related Issues (20)
- Panic on map of slices HOT 1
- Support for AllowUnknownFlags HOT 2
- Panic on parsing YAML configuration with empty lists HOT 2
- Deprecations HOT 4
- Add support for jsonx
- Panic when parse toml slice HOT 3
- YAML arrays can not be mapped to []string
- Update yaml parser to v3 HOT 2
- yaml decorder can't open file in embed file system HOT 2
- Feature Request: support any type that implements Setter (or any other similar) interface HOT 1
- feature: show environment variable names in usage HOT 2
- flagSet type is always string HOT 2
- Check that env is not empty HOT 5
- Unable to parse slice of nested struct from JSON HOT 1
- Reflection on slice kind ignores tags for field name
- Matrix parsing error (slice of slices) in yaml
- More examples and documentation HOT 2
- Error while parsing nested structs in slice in yaml file HOT 1
- Does aconfig support short and long versions of fields? HOT 4
- No support for native map syntax in files
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from aconfig.