kjuulh/yourconfig
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 3 Wiki Activity

chore: fmt

Browse Source
This commit is contained in:
kjuulh
2025-07-21 16:47:10 +02:00
parent 90f9012ae2
commit 02a82fbbe9
1 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,6 +1,7 @@
# yourconfig # yourconfig
A dead-simple Go library for loading config structs from environment variables — with optional tagging and required enforcement. A dead-simple Go library for loading config structs from environment variables —
with optional tagging and required enforcement.
## 📦 Install ## 📦 Install
@@ -26,10 +27,10 @@ type Config struct {
OtherItem string `conf:"MY_ITEM"` OtherItem string `conf:"MY_ITEM"`
// Loads YET_ANOTHER optionally from env // Loads YET_ANOTHER optionally from env
YetAnother string `conf:""` YetAnother string `conf:""`
// ignored field // ignored field
Ignored string Ignored string
} }
func main() { func main() {
@@ -42,8 +43,8 @@ func main() {
You configure fields using the `conf` struct tag: You configure fields using the `conf` struct tag:
* **Custom env name:** First item (e.g. `conf:"MY_ENV"`) - **Custom env name:** First item (e.g. `conf:"MY_ENV"`)
* **Options:** `key:value` or flags (e.g. `required:true`, or just `required`) - **Options:** `key:value` or flags (e.g. `required:true`, or just `required`)
Examples: Examples:
@@ -65,14 +66,16 @@ SomeItem string `conf:"DIFFERENT_NAME,required"`
// combine name and required (option) // combine name and required (option)
SomeItem string `conf:"DIFFERENT_NAME,required:true"` SomeItem string `conf:"DIFFERENT_NAME,required:true"`
``` ```
## ❗ Required Fields ## ❗ Required Fields
If a field is marked `required` and the environment variable is **not set**, loading will return an error. Use `MustLoad[T]()` to panic on error, or `Load[T]() (T, error)` to handle it gracefully. If a field is marked `required` and the environment variable is **not set**,
loading will return an error. Use `MustLoad[T]()` to panic on error, or
`Load[T]() (T, error)` to handle it gracefully.
Private (unexported) fields are ignored unless tagged — in which case they produce a `not settable` error, avoid setting `conf` on private items. Private (unexported) fields are ignored unless tagged — in which case they
produce a `not settable` error, avoid setting `conf` on private items.
## License ## License
@@ -81,9 +84,10 @@ MIT
## Contributing ## Contributing
```go ```go
go test ./... go test ./...
``` ```
## Release ## Release
Releases are handled through cuddle-please a pr based release tool, simply merge the pr and a release will be cut Releases are handled through cuddle-please a pr based release tool, simply merge
the pr and a release will be cut