optiongen

README

optiongen

a option gen tool for convenience

use it in Promgram

go test -v -run TestExecuteAny github.com/hauntedness/optiongen
=== RUN   TestExecuteAny
=== RUN   TestExecuteAny/github.com/hauntedness/optiongen/internal

package internal

import "io"

type CallOption func(*callOptions)

func (op *callOptions) ApplyOptions(opts ...CallOption) {
        for i := range opts {
                opts[i](op)
        }
}

var WithIntField = func(intField int) CallOption {
        return func(op *callOptions) {
                op.intField = intField
        }
}

var WithStringField = func(stringField string) CallOption {
        return func(op *callOptions) {
                op.stringField = stringField
        }
}

var WithInterfaceField = func(interfaceField interface{}) CallOption {
        return func(op *callOptions) {
                op.interfaceField = interfaceField
        }
}

var WithWriter = func(writer io.Writer) CallOption {
        return func(op *callOptions) {
                op.writer = writer
        }
}

--- PASS: TestExecuteAny (0.83s)
    --- PASS: TestExecuteAny/github.com/hauntedness/optiongen/internal (0.83s)
PASS
ok      github.com/hauntedness/optiongen        1.468s

Command line

go run github.com/hauntedness/optiongen/cmd/optiongen --type callOptions -package github.com/hauntedness/optiongen/internal

package internal

import "io"

type CallOption func(*callOptions)

func (op *callOptions) ApplyOptions(opts ...CallOption) {
        for i := range opts {
                opts[i](op)
        }
}

var WithIntField = func(intField int) CallOption {
        return func(op *callOptions) {
                op.intField = intField
        }
}

var WithStringField = func(stringField string) CallOption {
        return func(op *callOptions) {
                op.stringField = stringField
        }
}

var WithInterfaceField = func(interfaceField interface{}) CallOption {
        return func(op *callOptions) {
                op.interfaceField = interfaceField
        }
}

var WithWriter = func(writer io.Writer) CallOption {
        return func(op *callOptions) {
                op.writer = writer
        }
}

Documentation

Index

• Variables
• func BuilderFuncName(fieldName, prefix, postfix string) string
• func ExecuteAny(value any, args ...Option) string
• func ExecuteString(typeName string, packagePath string, args ...Option) string
• func ExecuteType(typ reflect.Type, args ...Option) string
• func Files(pkg *packages.Package) files
• func OptionTypeName(applyeeName string) string
• func OptionVarName(fieldName, prefix, postfix string) string
• type Field
• type Gen
  • func LoadDefinition(packagePath string, typeName string, conf *packages.Config) (g Gen, err error)
  • func (g Gen) FieldNameByIndex() string
  • func (g Gen) FieldTypeByIndex() string
  • func (g Gen) ParamNameByIndex() string
  • func (g Gen) ParamTypeByIndex() string
  • func (g Gen) ReceiverName() string
  • func (g Gen) Render(tmpl string) string
  • func (g Gen) RenderApplyFunc() string
  • func (g Gen) RenderChainFunc() string
  • func (g Gen) RenderOptionType() string
  • func (g Gen) RenderOptionVariable() string
• type Option

Variables

var WithAutoImports = func(autoImports bool) func(o *option) {
	return func(o *option) {
		o.autoImports = autoImports
	}
}

var WithBuilderMode = func(builderMode bool) func(o *option) {
	return func(o *option) {
		o.builderMode = builderMode
	}
}

var WithPostfix = func(postfix string) func(o *option) {
	return func(o *option) {
		o.postfix = postfix
	}
}

var WithPrefix = func(prefix string) func(o *option) {
	return func(o *option) {
		o.prefix = prefix
	}
}

var WithWriteFile = func(writeFile string) func(o *option) {
	return func(o *option) {
		o.writeFile = writeFile
	}
}

Functions

func BuilderFuncName

func BuilderFuncName(fieldName, prefix, postfix string) string

BuilderFuncName give the input variable a proper name

func ExecuteAny

func ExecuteAny(value any, args ...Option) string

func ExecuteString

func ExecuteString(typeName string, packagePath string, args ...Option) string

func ExecuteType

func ExecuteType(typ reflect.Type, args ...Option) string

func Files

func Files(pkg *packages.Package) files

TODO: currently, the implementation doesn't understand package alias implement this function in future need

func OptionTypeName

func OptionTypeName(applyeeName string) string

OptionTypeName give the option type a proper name replace xxxOptions --> XXXOption replace xxxConfig --> XXXOption replace xxxConfigs --> XXXOption

func OptionVarName

func OptionVarName(fieldName, prefix, postfix string) string

OptionVarName give the option variable a proper name

Types

type Field

type Field struct {
	FieldName string
	FieldType string
}

type Gen

type Gen struct {
	TypeName    string
	Fields      []Field
	Index       int
	WithPrefix  string
	WithPostfix string
	PackageName string
}

Gen is a wide type which will be rendered with a bunch of templates

func LoadDefinition

func LoadDefinition(packagePath string, typeName string, conf *packages.Config) (g Gen, err error)

func (Gen) FieldNameByIndex

func (g Gen) FieldNameByIndex() string

func (Gen) FieldTypeByIndex

func (g Gen) FieldTypeByIndex() string

func (Gen) ParamNameByIndex

func (g Gen) ParamNameByIndex() string

func (Gen) ParamTypeByIndex

func (g Gen) ParamTypeByIndex() string

func (Gen) ReceiverName

func (g Gen) ReceiverName() string

func (Gen) Render

func (g Gen) Render(tmpl string) string

func (Gen) RenderApplyFunc

func (g Gen) RenderApplyFunc() string

func (Gen) RenderChainFunc

func (g Gen) RenderChainFunc() string

func (Gen) RenderOptionType

func (g Gen) RenderOptionType() string

func (Gen) RenderOptionVariable

func (g Gen) RenderOptionVariable() string

type Option

type Option func(o *option)