Go Builder Pattern Boilerplate README

This extension generates the boilerplate code you need when using the builder pattern in Go.

It is available as the Go Builder Pattern Boilerplate extension in the VSC Marketplace and VSCodium Marketplace.

Features

The extension adds the command Generate Boilerplate. Select a struct and execute the command. The generated code will automatically be pasted under your selected text. You can use two different code generators: v1 and v2.

Example:

type Config struct {
	Address     string
	Port        uint16
	LogLevel    string
	Environment string
}

Select your struct in your editor. Execute the command "Generate Boilerplate" (with Ctrl + Shift + P and typing the command)

When using the old generator (v1), it adds the following lines of code:

type ConfigOption func(Config) Config

func WithAddress(address string) ConfigOption {
	return func(config Config) Config {
		config.Address = address
		return config
	}
}

func WithPort(port uint16) ConfigOption {
	return func(config Config) Config {
		config.Port = port
		return config
	}
}

func WithLogLevel(logLevel string) ConfigOption {
	return func(config Config) Config {
		config.LogLevel = logLevel
		return config
	}
}

func WithEnvironment(environment string) ConfigOption {
	return func(config Config) Config {
		config.Environment = environment
		return config
	}
}

func CreateDefaultConfig() Config {
	return Config{}
}

func CreateConfig(options ...ConfigOption) Config {
	config := CreateDefaultConfig()

	for _, option := range options {
		config = option(config)
	}

	return config
}

When using the newer v2 code generator, there will be generated the following code:

func (config *Config) WithAddress(address string) *Config {
	config.Address = address
	return config
}

func (config *Config) WithPort(port uint16) *Config {
	config.Port = port
	return config
}

func (config *Config) WithLogLevel(logLevel string) *Config {
	config.LogLevel = logLevel
	return config
}

func (config *Config) WithEnvironment(environment string) *Config {
	config.Environment = environment
	return config
}

func (config *Config) Build() Config {
	return *config
}

func DefaultConfig() *Config {
	return &Config{}
}

Usage of generated code

v1

config := CreateConfig(WithAddress("localhost"), WithPort(3000))

v2

config := DefaultConfig().WithAddress("localhost").WithPort(3000).Build()

Release Notes

Release history:

1.0.0

Initial release of the extension

1.0.1

• Add extension icon

1.0.2

• Changes to README and package.json

1.0.3

• Support for structs having multiple attributes declared in one line
  • for example with: A, B, C string

1.0.4

• Update README and CHANGELOG

1.0.5

• New code generator
• Option to switch to the old code generator

1.0.6

• Struct tags were not ignored, which lead to incorrect code generation

1.0.7

• Fix generation error, when using embedded structs like these:

type Struct1 {
	Property string
	Struct2
}

type Struct2 {
	AnotherProperty string
}