lang

Documentation

Index

• func GenerateGoMethodMutationsForPackage(s *schema.Schema, genConfig *config.GeneratorConfig, ...) (*[]GoMethod, error)
• func GenerateGoMethodQueriesForPackage(s *schema.Schema, genConfig *config.GeneratorConfig, ...) (*[]GoMethod, error)
• func GenerateGoTypesForPackage(s *schema.Schema, genConfig *config.GeneratorConfig, ...) (*[]GoStruct, *[]GoEnum, *[]GoScalar, *[]GoInterface, error)
• type Command
• type CommandExampleData
• type CommandFlag
• type CommandGenerator
• type GoEnum
• type GoEnumValue
• type GoInterface
• type GoInterfacePossibleType
• type GoMethod
• type GoMethodInputType
• type GoMethodSignature
• type GoScalar
• type GoStruct
• type GoStructField
• type GolangGenerator
• type InputObject
• type QueryVar

Functions

func GenerateGoMethodMutationsForPackage

func GenerateGoMethodMutationsForPackage(s *schema.Schema, genConfig *config.GeneratorConfig, pkgConfig *config.PackageConfig) (*[]GoMethod, error)

GenerateGoMethodMutationsForPackage uses the provided configuration to generate the GoMethod structs that contain the information about performing GraphQL mutations.

func GenerateGoMethodQueriesForPackage

func GenerateGoMethodQueriesForPackage(s *schema.Schema, genConfig *config.GeneratorConfig, pkgConfig *config.PackageConfig) (*[]GoMethod, error)

GenerateGoMethodQueriesForPackage uses the provided configuration to generate the GoMethod structs that contain the information about performing GraphQL queries.

func GenerateGoTypesForPackage

func GenerateGoTypesForPackage(s *schema.Schema, genConfig *config.GeneratorConfig, pkgConfig *config.PackageConfig, expandedTypes *[]*schema.Type) (*[]GoStruct, *[]GoEnum, *[]GoScalar, *[]GoInterface, error)

Types

type Command

type Command struct {
	Name             string
	CmdVariableName  string
	ShortDescription string
	LongDescription  string
	Example          string
	InputType        string
	ClientMethod     string
	ClientMethodArgs []string
	InputObjects     []InputObject
	Flags            []CommandFlag
	Subcommands      []Command

	GraphQLPath []string // Should mutations also use this? Probably
}

type CommandExampleData

type CommandExampleData struct {
	CLIName     string
	PackageName string
	Command     string
	Subcommand  string
	Flags       []CommandFlag
}

type CommandFlag

type CommandFlag struct {
	Name           string
	Type           string
	FlagMethodName string
	DefaultValue   string
	Description    string
	VariableName   string
	VariableType   string
	ClientType     string
	Required       bool
	IsInputType    bool
	IsEnumType     bool
}

type CommandGenerator

type CommandGenerator struct {
	PackageName string
	Imports     []string
	Commands    []Command
}

TODO: Move CommandGenerator and its friends to a proper home

type GoEnum

type GoEnum struct {
	Name        string
	Description string
	Values      []GoEnumValue
}

type GoEnumValue

type GoEnumValue struct {
	Name        string
	Description string
}

type GoInterface

type GoInterface struct {
	Name          string
	Description   string
	Type          string
	PossibleTypes []GoInterfacePossibleType
	Methods       []string
}

type GoInterfacePossibleType

type GoInterfacePossibleType struct {
	GoName      string
	GraphQLName string
}

type GoMethod

type GoMethod struct {
	Description string
	Name        string
	QueryVars   []QueryVar
	Signature   GoMethodSignature
	QueryString string
	// ResponseObjectType is the name of the type for the API response.  Note that this is not the method return, but the API call response.
	ResponseObjectType string
}

type GoMethodInputType

type GoMethodInputType struct {
	Name string
	Type string
}

type GoMethodSignature

type GoMethodSignature struct {
	Input  []GoMethodInputType
	Return []string
	// ReturnSlice indicates if the response is a slice of objects or not.  Used to flag KindList.
	ReturnSlice bool
	// Return path is the fields on the response object that nest the results the given method will return.
	ReturnPath []string
}

type GoScalar

type GoScalar struct {
	Name        string
	Description string
	Type        string
}

type GoStruct

type GoStruct struct {
	Name             string
	Description      string
	Fields           []GoStructField
	StructTags       []string
	Implements       []string
	SpecialUnmarshal bool
	GenerateGetters  bool
}

type GoStructField

type GoStructField struct {
	Name        string
	Type        string
	TypeName    string
	Tags        string
	TagKey      string
	Description string
	IsInterface bool
	IsList      bool
}

type GolangGenerator

type GolangGenerator struct {
	Types       []GoStruct
	PackageName string
	Enums       []GoEnum
	Imports     []string
	Scalars     []GoScalar
	Interfaces  []GoInterface
	Mutations   []GoMethod
	Queries     []GoMethod
}

GolangGenerator is enough information to generate Go code for a single package.

type InputObject

type InputObject struct {
	Name   string
	GoType string
}

type QueryVar

type QueryVar struct {
	Key   string
	Value string
	Type  string
}