config

Documentation

Index

• type Client
• type Config
  • func LoadConfig(filename string) (*Config, error)
  • func LoadConfigFromDefaultLocations() (*Config, error)
  • func (c *Config) LoadSchema(ctx context.Context) error
• type EndPointConfig
• type GenerateConfig
  • func (c *GenerateConfig) ShouldGenerateClient() bool
• type NamingConfig
• type StringList
  • func (a StringList) Has(file string) bool
• type TypeMap
• type TypeMapEntry

Types

type Client

type Client struct {
	config.PackageConfig `yaml:",inline"`

	ExtraTypes []string `yaml:"extra_types,omitempty"`
	InputAsMap bool     `yaml:"input_as_map"`
}

type Config

type Config struct {
	SchemaFilename StringList      `yaml:"schema,omitempty"`
	Client         Client          `yaml:"client,omitempty"`
	Models         TypeMap         `yaml:"models,omitempty"`
	Endpoint       *EndPointConfig `yaml:"endpoint,omitempty"`
	Generate       *GenerateConfig `yaml:"generate,omitempty"`

	Query []string `yaml:"query"`

	// gqlgen config struct
	GQLConfig *config.Config `yaml:"-"`
}

Config extends the gqlgen basic config and represents the config file

func LoadConfig

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

LoadConfig loads and parses the config gqlgenc config

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) LoadSchema

func (c *Config) LoadSchema(ctx context.Context) error

LoadSchema load and parses the schema from a local file or a remote server

type EndPointConfig

type EndPointConfig struct {
	URL     string            `yaml:"url"`
	Headers map[string]string `yaml:"headers,omitempty"`
}

EndPointConfig are the allowed options for the 'endpoint' config

type GenerateConfig

type GenerateConfig struct {
	Prefix *NamingConfig `yaml:"prefix,omitempty"`
	Suffix *NamingConfig `yaml:"suffix,omitempty"`
}

func (*GenerateConfig) ShouldGenerateClient

func (c *GenerateConfig) ShouldGenerateClient() bool

type NamingConfig

type NamingConfig struct {
	Query        string `yaml:"query,omitempty"`
	Mutation     string `yaml:"mutation,omitempty"`
	Subscription string `yaml:"subscription,omitempty"`
}

type StringList

type StringList []string

StringList is a simple array of strings

func (StringList) Has

func (a StringList) Has(file string) bool

Has checks if the strings array has a give value

type TypeMap

type TypeMap map[string]TypeMapEntry

type TypeMapEntry

type TypeMapEntry struct {
	config.TypeMapEntry `yaml:",inline"`

	AsMap bool `yaml:"as_map,omitempty"`
}