config

Documentation

Index

• Variables
• type Binder
  • func (b *Binder) CopyModifiersFromAst(t *ast.Type, base types.Type) types.Type
  • func (b *Binder) DefaultUserObject(name string) (types.Type, error)
  • func (b *Binder) FindObject(pkgName string, typeName string) (types.Object, error)
  • func (b *Binder) FindType(pkgName string, typeName string) (types.Type, error)
  • func (b *Binder) FindTypeFromName(name string) (types.Type, error)
  • func (b *Binder) ObjectPosition(typ types.Object) token.Position
  • func (b *Binder) PointerTo(ref *TypeReference) *TypeReference
  • func (b *Binder) PushRef(ret *TypeReference)
  • func (b *Binder) TypePosition(typ types.Type) token.Position
  • func (b *Binder) TypeReference(schemaType *ast.Type, bindTarget types.Type) (ret *TypeReference, err error)
• type Config
  • func DefaultConfig() *Config
  • func LoadConfig(filename string) (*Config, error)
  • func LoadConfigFromDefaultLocations() (*Config, error)
  • func (c *Config) Autobind(s *ast.Schema) error
  • func (c *Config) Check() error
  • func (c *Config) InjectBuiltins(s *ast.Schema)
  • func (c *Config) LoadSchema() (*ast.Schema, map[string]string, error)
  • func (c *Config) NewBinder(s *ast.Schema) (*Binder, error)
• type DirectiveConfig
• type PackageConfig
  • func (c *PackageConfig) Check() error
  • func (c *PackageConfig) Dir() string
  • func (c *PackageConfig) ImportPath() string
  • func (c *PackageConfig) IsDefined() bool
  • func (c *PackageConfig) Pkg() *types.Package
• type PkgErrors
  • func (p PkgErrors) Error() string
• type StringList
  • func (a StringList) Has(file string) bool
  • func (a *StringList) UnmarshalYAML(unmarshal func(interface{}) error) error
• type TypeMap
  • func (tm TypeMap) Add(name string, goType string)
  • func (tm TypeMap) Check() error
  • func (tm TypeMap) Exists(typeName string) bool
  • func (tm TypeMap) ReferencedPackages() []string
  • func (tm TypeMap) UserDefined(typeName string) bool
• type TypeMapEntry
• type TypeMapField
• type TypeReference
  • func (ref *TypeReference) Elem() *TypeReference
  • func (t *TypeReference) IsNamed() bool
  • func (t *TypeReference) IsNilable() bool
  • func (t *TypeReference) IsPtr() bool
  • func (t *TypeReference) IsScalar() bool
  • func (t *TypeReference) IsSlice() bool
  • func (t *TypeReference) IsStruct() bool
  • func (t *TypeReference) MarshalFunc() string
  • func (t *TypeReference) UniquenessKey() string
  • func (t *TypeReference) UnmarshalFunc() string

Variables

var InterfaceType = types.NewInterfaceType(nil, nil)

var MapType = types.NewMap(types.Typ[types.String], types.NewInterfaceType(nil, nil).Complete())

Types

type Binder

type Binder struct {
	References []*TypeReference
	PkgErrors  PkgErrors
	SawInvalid bool
	// contains filtered or unexported fields
}

Binder connects graphql types to golang types using static analysis

func (*Binder) CopyModifiersFromAst

func (b *Binder) CopyModifiersFromAst(t *ast.Type, base types.Type) types.Type

func (*Binder) DefaultUserObject

func (b *Binder) DefaultUserObject(name string) (types.Type, error)

func (*Binder) FindObject

func (b *Binder) FindObject(pkgName string, typeName string) (types.Object, error)

func (*Binder) FindType

func (b *Binder) FindType(pkgName string, typeName string) (types.Type, error)

func (*Binder) FindTypeFromName

func (b *Binder) FindTypeFromName(name string) (types.Type, error)

func (*Binder) ObjectPosition

func (b *Binder) ObjectPosition(typ types.Object) token.Position

func (*Binder) PointerTo

func (b *Binder) PointerTo(ref *TypeReference) *TypeReference

func (*Binder) PushRef

func (b *Binder) PushRef(ret *TypeReference)

func (*Binder) TypePosition

func (b *Binder) TypePosition(typ types.Type) token.Position

func (*Binder) TypeReference

func (b *Binder) TypeReference(schemaType *ast.Type, bindTarget types.Type) (ret *TypeReference, err error)

type Config

type Config struct {
	SchemaFilename           StringList                 `yaml:"schema,omitempty"`
	Exec                     PackageConfig              `yaml:"exec"`
	Model                    PackageConfig              `yaml:"model,omitempty"`
	Resolver                 PackageConfig              `yaml:"resolver,omitempty"`
	AutoBind                 []string                   `yaml:"autobind"`
	Models                   TypeMap                    `yaml:"models,omitempty"`
	StructTag                string                     `yaml:"struct_tag,omitempty"`
	Directives               map[string]DirectiveConfig `yaml:"directives,omitempty"`
	OmitSliceElementPointers bool                       `yaml:"omit_slice_element_pointers,omitempty"`
	SkipValidation           bool                       `yaml:"skip_validation,omitempty"`
}

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig creates a copy of the default config

func LoadConfig

func LoadConfig(filename string) (*Config, error)

LoadConfig reads the gqlgen.yml config file

func LoadConfigFromDefaultLocations

func LoadConfigFromDefaultLocations() (*Config, error)

LoadConfigFromDefaultLocations looks for a config file in the current directory, and all parent directories walking up the tree. The closest config file will be returned.

func (*Config) Autobind

func (c *Config) Autobind(s *ast.Schema) error

func (*Config) Check

func (c *Config) Check() error

func (*Config) InjectBuiltins

func (c *Config) InjectBuiltins(s *ast.Schema)

func (*Config) LoadSchema

func (c *Config) LoadSchema() (*ast.Schema, map[string]string, error)

func (*Config) NewBinder

func (c *Config) NewBinder(s *ast.Schema) (*Binder, error)

type DirectiveConfig

type DirectiveConfig struct {
	SkipRuntime bool `yaml:"skip_runtime"`
}

type PackageConfig

type PackageConfig struct {
	Filename string `yaml:"filename,omitempty"`
	Package  string `yaml:"package,omitempty"`
	Type     string `yaml:"type,omitempty"`
}

func (*PackageConfig) Check

func (c *PackageConfig) Check() error

func (*PackageConfig) Dir

func (c *PackageConfig) Dir() string

func (*PackageConfig) ImportPath

func (c *PackageConfig) ImportPath() string

func (*PackageConfig) IsDefined

func (c *PackageConfig) IsDefined() bool

func (*PackageConfig) Pkg

func (c *PackageConfig) Pkg() *types.Package

type PkgErrors

type PkgErrors []packages.Error

func (PkgErrors) Error

func (p PkgErrors) Error() string

type StringList

type StringList []string

func (StringList) Has

func (a StringList) Has(file string) bool

func (*StringList) UnmarshalYAML

func (a *StringList) UnmarshalYAML(unmarshal func(interface{}) error) error

type TypeMap

type TypeMap map[string]TypeMapEntry

func (TypeMap) Add

func (tm TypeMap) Add(name string, goType string)

func (TypeMap) Check

func (tm TypeMap) Check() error

func (TypeMap) Exists

func (tm TypeMap) Exists(typeName string) bool

func (TypeMap) ReferencedPackages

func (tm TypeMap) ReferencedPackages() []string

func (TypeMap) UserDefined

func (tm TypeMap) UserDefined(typeName string) bool

type TypeMapEntry

type TypeMapEntry struct {
	Model  StringList              `yaml:"model"`
	Fields map[string]TypeMapField `yaml:"fields,omitempty"`
}

type TypeMapField

type TypeMapField struct {
	Resolver  bool   `yaml:"resolver"`
	FieldName string `yaml:"fieldName"`
}

type TypeReference

type TypeReference struct {
	Definition  *ast.Definition
	GQL         *ast.Type
	GO          types.Type
	CastType    types.Type  // Before calling marshalling functions cast from/to this base type
	Marshaler   *types.Func // When using external marshalling functions this will point to the Marshal function
	Unmarshaler *types.Func // When using external marshalling functions this will point to the Unmarshal function
	IsMarshaler bool        // Does the type implement graphql.Marshaler and graphql.Unmarshaler
}

TypeReference is used by args and field types. The Definition can refer to both input and output types.

func (*TypeReference) Elem

func (ref *TypeReference) Elem() *TypeReference

func (*TypeReference) IsNamed

func (t *TypeReference) IsNamed() bool

func (*TypeReference) IsNilable

func (t *TypeReference) IsNilable() bool

func (*TypeReference) IsPtr

func (t *TypeReference) IsPtr() bool

func (*TypeReference) IsScalar

func (t *TypeReference) IsScalar() bool

func (*TypeReference) IsSlice

func (t *TypeReference) IsSlice() bool

func (*TypeReference) IsStruct

func (t *TypeReference) IsStruct() bool

func (*TypeReference) MarshalFunc

func (t *TypeReference) MarshalFunc() string

func (*TypeReference) UniquenessKey

func (t *TypeReference) UniquenessKey() string

func (*TypeReference) UnmarshalFunc

func (t *TypeReference) UnmarshalFunc() string