helper

Documentation

Index

• func CamelCaseSlice(elem []string) string
• func CheckProtoSyntax(file *descriptorpb.FileDescriptorProto) error
• func ClearPointer(s string) string
• func ConvertToNullType(field *descriptorpb.FieldDescriptorProto) string
• func ConvertType(field *descriptorpb.FieldDescriptorProto) string
• func ConvertTypeSQLite(field *descriptorpb.FieldDescriptorProto) string
• func CopyMessage(src *descriptorpb.DescriptorProto) *descriptorpb.DescriptorProto
• func DetectField(structName string) string
• func DetectMany(t string) bool
• func DetectReference(structName string) string
• func DetectStoreName(t string) string
• func DetectStructName(t string) string
• func DetectTableName(t string) string
• func DetermineRelationDirection(rd *descriptorpb.DescriptorProto, pd *descriptorpb.DescriptorProto) string
• func DumpPrint(values ...interface{})
• func ExecuteTemplate(tmpl string, funcs template.FuncMap, data any, templates ...IncludeTemplate) (string, error)
• func FirstLetterLower(s string) (string, error)
• func GetDBOptions(f *descriptorpb.FileDescriptorProto) *structify.StructifyDBOptions
• func GetFieldOptions(f *descriptorpb.FieldDescriptorProto) *structify.StructifyFieldOptions
• func GetMessageOptions(d *descriptorpb.DescriptorProto) *structify.StructifyMessageOptions
• func GetUserProtoFile(req *plugingo.CodeGeneratorRequest) *descriptorpb.FileDescriptorProto
• func GetUserProtoFiles(req *plugingo.CodeGeneratorRequest) []*descriptorpb.FileDescriptorProto
• func GoFmt(resp *plugingo.CodeGeneratorResponse) error
• func GoTypeToPostgresType(goType string) string
• func GoTypeToSQLiteType(goType string) string
• func HasIndex(f *descriptorpb.FieldDescriptorProto) bool
• func HasUnique(f *descriptorpb.FieldDescriptorProto) bool
• func IsContainsStar(s string) bool
• func IsOptional(field *descriptorpb.FieldDescriptorProto) bool
• func IsRepeated(field *descriptorpb.FieldDescriptorProto) bool
• func IsUserMessage(f *descriptorpb.FileDescriptorProto, m *descriptorpb.DescriptorProto) bool
• func LowerCamelCase(name string) string
• func LowerClientName(name string) string
• func Plural(name string) string
• func PostgresType(goType string, options *structify.StructifyFieldOptions, isJson bool) string
• func SQLiteType(goType string, options *structify.StructifyFieldOptions, isJson bool) string
• func SliceToString(slice []string) string
• func SnakeCase(name string) string
• func ToLower(name string) string
• func TypePrefix(field *descriptorpb.FieldDescriptorProto, typeName string) string
• func UpperCamelCase(name string) string
• func UpperClientName(name string) string
• type DescriptorMList
• type IncludeTemplate

Functions

func CamelCaseSlice

func CamelCaseSlice(elem []string) string

CamelCaseSlice returns the camel case of a slice.

func CheckProtoSyntax

func CheckProtoSyntax(file *descriptorpb.FileDescriptorProto) error

CheckProtoSyntax checks if the syntax of the file is proto3.

func ClearPointer

func ClearPointer(s string) string

ClearPointer removes the pointer and slice from a string.

func ConvertToNullType

func ConvertToNullType(field *descriptorpb.FieldDescriptorProto) string

ConvertToNullType converts a field descriptor type to its corresponding nullable type.

func ConvertType

func ConvertType(field *descriptorpb.FieldDescriptorProto) string

ConvertType converts a protobuf type to a Go type.

func ConvertTypeSQLite

func ConvertTypeSQLite(field *descriptorpb.FieldDescriptorProto) string

func CopyMessage

func CopyMessage(src *descriptorpb.DescriptorProto) *descriptorpb.DescriptorProto

func DetectField

func DetectField(structName string) string

DetectField returns the field name.

func DetectMany

func DetectMany(t string) bool

DetectMany returns true if the field is a many relation.

func DetectReference

func DetectReference(structName string) string

DetectReference returns the reference field name.

func DetectStoreName

func DetectStoreName(t string) string

DetectStoreName returns the postgres type for the given type.

func DetectStructName

func DetectStructName(t string) string

DetectStructName returns the struct name for the given type.

func DetectTableName

func DetectTableName(t string) string

DetectTableName returns the postgres type for the given type.

func DetermineRelationDirection

func DetermineRelationDirection(rd *descriptorpb.DescriptorProto, pd *descriptorpb.DescriptorProto) string

DetermineRelationDirection determines the relation direction.

func DumpPrint

func DumpPrint(values ...interface{})

func ExecuteTemplate

func ExecuteTemplate(tmpl string, funcs template.FuncMap, data any, templates ...IncludeTemplate) (string, error)

ExecuteTemplate executes a template.

func FirstLetterLower

func FirstLetterLower(s string) (string, error)

FirstLetterLower converts the first letter of a string to lowercase.

func GetDBOptions

func GetDBOptions(f *descriptorpb.FileDescriptorProto) *structify.StructifyDBOptions

GetDBOptions returns the custom options for a file.

func GetFieldOptions

func GetFieldOptions(f *descriptorpb.FieldDescriptorProto) *structify.StructifyFieldOptions

GetFieldOptions returns the custom options for a field.

func GetMessageOptions

func GetMessageOptions(d *descriptorpb.DescriptorProto) *structify.StructifyMessageOptions

GetMessageOptions returns the custom options for a message.

func GetUserProtoFile

func GetUserProtoFile(req *plugingo.CodeGeneratorRequest) *descriptorpb.FileDescriptorProto

GetUserProtoFile returns the first user proto file.

func GetUserProtoFiles

func GetUserProtoFiles(req *plugingo.CodeGeneratorRequest) []*descriptorpb.FileDescriptorProto

GetUserProtoFiles returns the user proto files.

func GoFmt

func GoFmt(resp *plugingo.CodeGeneratorResponse) error

GoFmt formats the generated Go code.

func GoTypeToPostgresType

func GoTypeToPostgresType(goType string) string

GoTypeToPostgresType returns the postgres type for the given type.

func GoTypeToSQLiteType

func GoTypeToSQLiteType(goType string) string

GoTypeToSQLiteType returns the postgres type for the given type.

func HasIndex

func HasIndex(f *descriptorpb.FieldDescriptorProto) bool

HasIndex returns the index option for a field.

func HasUnique

func HasUnique(f *descriptorpb.FieldDescriptorProto) bool

HasUnique returns the unique option for a field.

func IsContainsStar

func IsContainsStar(s string) bool

IsContainsStar returns true if the string contains a star.

func IsOptional

func IsOptional(field *descriptorpb.FieldDescriptorProto) bool

IsOptional returns true if the field is optional and not a string, bytes, int32, int64, float32, float64, bool, uint32, uint64 type or a Google Protobuf wrapper message.

func IsRepeated

func IsRepeated(field *descriptorpb.FieldDescriptorProto) bool

IsRepeated returns true if the field is repeated.

func IsUserMessage

func IsUserMessage(f *descriptorpb.FileDescriptorProto, m *descriptorpb.DescriptorProto) bool

IsUserMessage returns true if the message is not a google.protobuf or structify message.

func LowerCamelCase

func LowerCamelCase(name string) string

LowerCamelCase converts a string to a lowerCamelCase string.

func LowerClientName

func LowerClientName(name string) string

LowerClientName returns the lowerCamelCase name of the client.

func Plural

func Plural(name string) string

Plural converts a string to a plural string.

func PostgresType

func PostgresType(goType string, options *structify.StructifyFieldOptions, isJson bool) string

PostgresType returns the postgres type for the given type.

func SQLiteType

func SQLiteType(goType string, options *structify.StructifyFieldOptions, isJson bool) string

func SliceToString

func SliceToString(slice []string) string

SliceToString converts a slice of strings to a string.

func SnakeCase

func SnakeCase(name string) string

func ToLower

func ToLower(name string) string

ToLower converts a string to a lower string.

func TypePrefix

func TypePrefix(field *descriptorpb.FieldDescriptorProto, typeName string) string

TypePrefix returns the type prefix.

func UpperCamelCase

func UpperCamelCase(name string) string

UpperCamelCase converts a string to a CamelCase string.

func UpperClientName

func UpperClientName(name string) string

UpperClientName returns the upperCamelCase name of the client.

Types

type DescriptorMList

type DescriptorMList map[string]*descriptorpb.DescriptorProto

DescriptorMList is a map of descriptors.

type IncludeTemplate

type IncludeTemplate struct {
	Name string
	Body string
}