generator

Documentation

Index

• Constants
• func DefaultNameGenerator(packageName, typeName string) string
• func Generate()
• func NormalizedFileName(s string) string
• type Extern
• type GQLIdent
  • func (g *GQLIdent) String() string
• type GQLType
• type Generator
  • func NewGenerator(typeNameGenerator TypeNameGenerator, baseFileName string, options Options) Generator
• type MapEntry
• type ObjectField
• type Option
  • func NewOption(key, value string) Option
• type Options
  • func (opts Options) Get(key string) (string, bool)
• type Printer
• type Symbol
  • func NewSymbol(parent *Symbol, ident GQLIdent) *Symbol
• type SymbolTable
  • func (t *SymbolTable) Append(s *Symbol)
  • func (t *SymbolTable) Exist(ident GQLIdent) bool
  • func (t *SymbolTable) LookUp(ident GQLIdent) (*Symbol, bool)
• type TypeInfo
  • func (t *TypeInfo) GetName() string
  • func (t *TypeInfo) String() string
• type TypeNameGenerator
• type UnionField
• type Visitor
  • func NewVisitor(f *protogen.File, g *protogen.GeneratedFile, importPath string) Visitor

Constants

const (
	OptionGraphQL string = "(graphql.type)"

	ImportPrefixOption = "import_prefix"
	ImportPathOption   = "import_path"
)

const (
	GQLTypeObject   GQLType = GQLType("Object")
	GQLTypeInput            = GQLType("Input")
	GQLTypeScalar           = GQLType("Scalar")
	GQLTypeEnum             = GQLType("Enum")
	GQLTypeQuery            = GQLType("Query")
	GQLTypeMutation         = GQLType("Mutation")
)

Functions

func DefaultNameGenerator

func DefaultNameGenerator(packageName, typeName string) string

DefaultNameGenerator is a default type name generator

func Generate

func Generate()

func NormalizedFileName

func NormalizedFileName(s string) string

Types

type Extern

type Extern struct {
	ProtoPackage string
	ImportAlias  string
	SourcePath   string
}

type GQLIdent

type GQLIdent struct {
	protogen.GoIdent
	Type GQLType
	// contains filtered or unexported fields
}

func (*GQLIdent) String

func (g *GQLIdent) String() string

type GQLType

type GQLType string

type Generator

type Generator interface {
	FromProto(*descriptorpb.FileDescriptorProto, string, string) (bool, error)
	GetFieldType(*descriptorpb.DescriptorProto, *descriptorpb.FieldDescriptorProto, string) *TypeInfo
	GetObjectFields(*descriptorpb.DescriptorProto) *ObjectField
	GetProtobufFieldName(string) string
	GetInputType(string) string
	GetOutputType(string) string
	GetEnumType(string) string
	GetLanguageType(string) string
	GetGraphQLTypeName(string) string
	GetExternal(string) (*Extern, bool)
	HasOperation() bool
}

Generator is an interface of graphql code generator

func NewGenerator

func NewGenerator(typeNameGenerator TypeNameGenerator, baseFileName string, options Options) Generator

type MapEntry

type MapEntry struct {
	KeyField   string
	KeyType    string
	ValueField string
	ValueType  string
}

type ObjectField

type ObjectField struct {
	Fields    []*descriptorpb.FieldDescriptorProto
	Unions    map[string][]*descriptorpb.FieldDescriptorProto
	Maps      []*descriptorpb.FieldDescriptorProto
	MapTypes  map[string]MapEntry
	HasFields bool
}

type Option

type Option interface {
	Name() string
	Value() string
}

func NewOption

func NewOption(key, value string) Option

type Options

type Options []Option

func (Options) Get

func (opts Options) Get(key string) (string, bool)

type Printer

type Printer interface {
	Enter()
	Exit()
	P(...interface{}) Printer
}

type Symbol

type Symbol struct {
	Ident  GQLIdent
	Parent *Symbol
}

func NewSymbol

func NewSymbol(parent *Symbol, ident GQLIdent) *Symbol

type SymbolTable

type SymbolTable struct {
	// contains filtered or unexported fields
}

func (*SymbolTable) Append

func (t *SymbolTable) Append(s *Symbol)

func (*SymbolTable) Exist

func (t *SymbolTable) Exist(ident GQLIdent) bool

func (*SymbolTable) LookUp

func (t *SymbolTable) LookUp(ident GQLIdent) (*Symbol, bool)

type TypeInfo

type TypeInfo struct {
	Name         string
	Prefix       string
	PackageName  string
	Suffix       string
	IsScalar     bool
	IsRepeated   bool
	IsNonNull    bool
	LanguageType string
}

func (*TypeInfo) GetName

func (t *TypeInfo) GetName() string

func (*TypeInfo) String

func (t *TypeInfo) String() string

type TypeNameGenerator

type TypeNameGenerator func(packageName, typeName string) string

TypeNameGenerator is function type to generate GraphQL type from protobuf object type

type UnionField

type UnionField struct {
	Message *descriptorpb.DescriptorProto
	Field   *descriptorpb.FieldDescriptorProto
}

type Visitor

type Visitor interface {
	Content() ([]byte, error)
	Visit(parent *Symbol, f *protogen.File)
	VisitEnum(parent *Symbol, enumDescriptor *protogen.Enum)
	VisitMessage(parent *Symbol, p *protogen.Message, typ GQLType)
	VisitField(symbol *Symbol, p *protogen.Field, typ GQLType)
	VisitOneOf(symbol *Symbol, p *protogen.Oneof, typ GQLType)
	VisitService(symbol *Symbol, p *protogen.Service)
}

func NewVisitor

func NewVisitor(f *protogen.File, g *protogen.GeneratedFile, importPath string) Visitor