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
91
92
93
94
95
96
97
98
99
100
101
|
# A Kong configuration loader for HCL [](http://godoc.org/github.com/alecthomas/kong-hcl) [](https://circleci.com/gh/alecthomas/kong-hcl)
This is version 1.x of kong-hcl. [Version 2](https://github.com/alecthomas/kong-hcl/tree/master/v2)
of this package uses the HCL2 library but is otherwise largely a drop-in replacement
(see the README for details).
Use it like so:
```go
var cli struct {
Config kong.ConfigFlag `help:"Load configuration."`
}
parser, err := kong.New(&cli, kong.Configuration(konghcl.Loader, "/etc/myapp/config.hcl", "~/.myapp.hcl))
```
## Mapping HCL fragments to a struct
More complex structures can be loaded directly into flag values by implementing the
`kong.MapperValue` interface, and calling `konghcl.DecodeValue`.
The value can either be a HCL(/JSON) fragment, or a path to a HCL file that will be loaded. Both
can be specified on the command-line or config file.
eg.
```go
type NestedConfig struct {
Size int
Name string
}
type ComplexConfig struct {
Key bool
Nested map[string]NestedConfig
}
func (c *ComplexConfig) Decode(ctx *kong.DecodeContext) error {
return konghcl.DecodeValue(ctx, c)
}
// ...
type Config struct {
Complex ComplexConfig
}
```
Then the following `.hcl` config fragment will be decoded into `Complex`:
```hcl
complex {
key = true
nested first {
size = 10
name = "first name"
}
nested second {
size = 12
name = "second name"
}
}
```
## Configuration layout
Configuration keys are mapped directly to flags.
Additionally, HCL block keys will be used as a hyphen-separated prefix when looking up flags.
## Example
The following Kong CLI:
```go
type CLI struct {
Debug bool
DB struct {
DSN string
Trace bool
} `embed:"" prefix:"db-"`
}
```
Maps to the following flags:
```
--debug
--db-dsn=<string>
--db-trace
```
And can be configured via the following HCL configuration file...
```hcl
debug = true
db {
dsn = "root@/database"
trace = true
}
```
|
