dysconfig

Dysfunctional options pattern in Go

This code generator is inspired by the article Dysfunctional options pattern in Go by Redowan Delowar.

Now you can define configuration struct(s) schema in a tiny JSON file and use this generator to make up Go code for you.

Installation

go install -u github.com/burmuley/dysconfig@latest

Command line parameters

• -schema - path to the JSON file with the schema; default: config_schema.json
• -output - path to the output file; default: stdout
• -package - package name; default: main
• -headers - add header and footer wrapping the generated output; default: true

go:generate example

//go:generate dysconfig -schema=config_schema.json -output=config.go -package=testoutput

Configuration schema example

[
  {
    "struct_name": "DatabaseConfig",
    "json_tags": true,
    "fields": {
      "Address": {
        "type": "string",
        "required": true
      },
      "Login": {
        "type": "string",
        "required": false,
        "default": "root"
      },
      "Password": {
        "type": "string",
        "required": false,
        "default": "secret_password"
      },
      "DatabaseName": {
        "type": "string",
        "required": true
      }
    }
  }
]

After running the generator, you will get the following code:

dysconfig -schema example.json -output config.go -package testoutput

package testoutput

type DatabaseConfig struct {
	Address      string `json:"Address,required"`
	Login        string `json:"Login"`
	DatabaseName string `json:"DatabaseName,required"`
	Password     string `json:"Password"`
}

func NewDatabaseConfig(address string, databasename string) *DatabaseConfig {
	return &DatabaseConfig{
		Address:      address,
		Login:        "root",
		DatabaseName: databasename,
		Password:     "secret_password",
	}
}

func (c *DatabaseConfig) WithLogin(value string) *DatabaseConfig {
	c.Login = value
	return c
}

func (c *DatabaseConfig) WithPassword(value string) *DatabaseConfig {
	c.Password = value
	return c
}