https://github.com/jhoelzel/jsonconfig
jsonconfig is a simple golang package that reads a JSON configuration file from any path into a strongly typed struct and vice versa.
https://github.com/jhoelzel/jsonconfig
golang-package json
Last synced: 5 months ago
JSON representation
jsonconfig is a simple golang package that reads a JSON configuration file from any path into a strongly typed struct and vice versa.
- Host: GitHub
- URL: https://github.com/jhoelzel/jsonconfig
- Owner: jhoelzel
- License: mit
- Created: 2017-08-06T08:26:17.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-06T14:01:46.000Z (almost 9 years ago)
- Last Synced: 2024-06-20T20:07:14.064Z (about 2 years ago)
- Topics: golang-package, json
- Language: Go
- Homepage: https://github.com/jhoelzel/jsonconfig
- Size: 7.81 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# jsonconfig
**Package Name:** jsonconfig
**Author :** jhoelzel
**URL :** github.com/jhoelzel/jsonconfig
**License :** [MIT](LICENSE)
**Version :** 0.0.1
Summary
--------------
jsonconfig is a simple golang package that reads a simple JSON configuration file from any path into a strongly typed struct and vice versa.
Why a JSON config file
--------------
Most of the time changing minor settings in your application is paramount, but most of the time they cause downtime.
jsonconfig enables you to adapt your configuration however you like by simply reloading the configuration as needed.
Furthermore, using the JSON Format, enables you to not only change settings yourself with a simple text editor, but also have machines to the jobs for you ;)
Usage
--------------
*in your code *
```golang
import (
"github.com/jhoelzel/jsonconfig"
)
var config jsonconfig.Configuration
func main() {
config = jsonconfig.Read("./config.json")
}
```
Methods
--------------
| Command | Description |
| --- | --- |
| jsonconfig.Read("./config.json") | Read the json file from "./config.json" and return Configuration |
| jsonconfig.Write(Configuration, "./config.json") | Write the Configuration to "./config.json" |
| jsonconfig.Configuration | The "Configuration" Type |
The configuration File
--------------
*HowEverYouChooseToNameIt.json*
```json
{
"Globals": {
"url": "https://yourdomain.tld",
"theme": "default",
"date_format": "m/d/Y",
"time_format" : "h:ia",
"decimal_seperator" : ".",
"language" : "en_us",
"version" : "0.0.1"
},
"Admin": {
"email": "admin@yourdomain.tld",
"name": "Admin Adminicus"
},
"Emails": {
"name": "no-reply Server",
"host": "yourdomain.tld",
"port": "587",
"email": "no-reply@yourdomain.tld",
"username": "no-reply@yourdomain.tld",
"password": "...",
"mechanism": "TLS"
},
"Login": {
"username": "admin@yourdomain.tld",
"password": "VeryUnsecureClearTextPW"
},
"Database": {
"username": "root",
"password": "root",
"dbname": "testdb",
"host": "mysql.yourdomain.tld",
"port": "587"
}
}
```
But your configuration flags suck!
--------------
While that topic is up for debate, this repository has been created to quickly build a new Package using Golang that works for me.
Your needs may be different, but do not despair! You may simply hit the fork button and create your own version.
To do that change the following files:
| [models.go](models.go) | [main_test.go](main_test.go) |
| ------------- | -------------
| add new Models here | make sure your new Models are also tested |
I have a better idea for X
--------------
Pull requests are allways welcome =)