json2enum

package module

v0.0.0-...-09bf76e Latest Latest Go to latest Published: Sep 25, 2019 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ledongthuc/json2enum

Links

Open Source Insights

README ¶

json2enum

Documentation ¶

Index ¶

Variables
func Convert(r io.Reader) (io.Reader, error)
func ConvertFromBytes(data []byte) (io.Reader, error)
func ConvertFromString(data string) (io.Reader, error)
type Converter
- func New() Converter
- func NewWithDefaultSetting() Converter
type TemplateField
type TemplateFields
type TemplateParameters
- func (t *TemplateParameters) GenerateTypePlural()
- func (t *TemplateParameters) GenerateTypeSingular()

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrorCantReadData       = errors.New("Can't read stream json data")
	ErrorInvalidArrayToPath = errors.New("Array's path is not valid value. If json data is array of string, you can use '#()#'")
	ErrorInvalidTypeName    = errors.New("Type name is not valid.")
	ErrorInvalidPackageName = errors.New("Package name is not valid.")
)

Functions ¶

func Convert ¶

func Convert(r io.Reader) (io.Reader, error)

Convert json to enum bases on reader stream. Returned reader's always nil when has error.

func ConvertFromBytes ¶

func ConvertFromBytes(data []byte) (io.Reader, error)

func ConvertFromString ¶

func ConvertFromString(data string) (io.Reader, error)

Types ¶

type Converter ¶

type Converter struct {
	PathToArray string
	EnumPrefix  string
	TypeName    string
	PackageName string
}

func New ¶

func New() Converter

New will create a instance of Converter, that's useful for adding custom value to generate.

func NewWithDefaultSetting ¶

func NewWithDefaultSetting() Converter

NewWithDefaultSetting will create a instance of Converter, that's useful for adding custom value to generate.

func (Converter) Convert ¶

func (c Converter) Convert(r io.Reader) (io.Reader, error)

func (Converter) ConvertFromBytes ¶

func (c Converter) ConvertFromBytes(data []byte) (io.Reader, error)

func (Converter) ConvertFromString ¶

func (c Converter) ConvertFromString(data string) (io.Reader, error)

func (*Converter) IsValid ¶

func (c *Converter) IsValid() (bool, error)

IsValid validates input data before converting it to source file.

func (*Converter) SetDefault ¶

func (c *Converter) SetDefault()

SetDefault set input data with default values. It's used for run without entering any custom configuration to generate source code.

type TemplateField ¶

type TemplateField struct {
	Name  string
	Value string
	Raw   string
}

type TemplateFields ¶

type TemplateFields []TemplateField

type TemplateParameters ¶

type TemplateParameters struct {
	PackageName  string
	Type         string
	TypeSingular string
	TypePlural   string
	Fields       TemplateFields
}

func (*TemplateParameters) GenerateTypePlural ¶

func (t *TemplateParameters) GenerateTypePlural()

func (*TemplateParameters) GenerateTypeSingular ¶

func (t *TemplateParameters) GenerateTypeSingular()

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL