config

Documentation

Overview

Package config handles loading and validating structql configuration.

Index

• type Config
  • func DefaultConfig() *Config
  • func Load(path string) (*Config, error)
  • func (c *Config) Marshal() ([]byte, error)
• type ScalarConfig

Types

type Config

type Config struct {
	Schema       []string                `yaml:"schema"`
	Queries      string                  `yaml:"queries"`
	Output       string                  `yaml:"output"`
	Package      string                  `yaml:"package"`
	Scalars      map[string]ScalarConfig `yaml:"scalars,omitempty"`
	TypeMappings map[string]string       `yaml:"type_mappings,omitempty"`
	Prefix       string                  `yaml:"prefix,omitempty"`
	// contains filtered or unexported fields
}

Config represents the structql configuration file.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns a config with sensible defaults for scaffolding.

func Load

func Load(path string) (*Config, error)

Load reads and parses a config file, resolving paths relative to the config file location.

func (*Config) Marshal

func (c *Config) Marshal() ([]byte, error)

Marshal serializes the config to YAML bytes.

type ScalarConfig

type ScalarConfig struct {
	Type   string `yaml:"type"`
	Import string `yaml:"import,omitempty"`
}

ScalarConfig defines how a custom GraphQL scalar maps to a Go type.