config

README

sdk-gen-config

Documentation

Index

• Constants
• Variables
• func Save(dir string, cfg *Config, opts ...Option) error
• type Comments
• type Config
  • func GetDefaultConfig(getLangDefaultFunc GetLanguageDefaultFunc, langs ...string) (*Config, error)
  • func Load(dir string, opts ...Option) (*Config, error)
• type Generation
• type GetLanguageDefaultFunc
• type LanguageConfig
• type Management
• type Option
  • func WithFileSystemFuncs(rf ReadFileFunc, wf WriteFileFunc) Option
  • func WithLanguageDefaultFunc(f GetLanguageDefaultFunc) Option
  • func WithLanguages(langs ...string) Option
  • func WithUpgradeFunc(f UpgradeFunc) Option
• type ReadFileFunc
• type UpgradeFunc
• type WriteFileFunc

Constants

const Version = "1.0.0"

Variables

var ErrFailedUpgrade = errors.New("failed to upgrade config")

var ErrNotFound = errors.New("could not find gen.yaml")

Functions

func Save

func Save(dir string, cfg *Config, opts ...Option) error

Types

type Comments

type Comments struct {
	Disabled                        bool `yaml:"disabled,omitempty"`
	OmitDescriptionIfSummaryPresent bool `yaml:"omitDescriptionIfSummaryPresent,omitempty"`
}

type Config

type Config struct {
	ConfigVersion string                    `yaml:"configVersion"`
	Management    *Management               `yaml:"management,omitempty"`
	Generation    Generation                `yaml:"generation"`
	Languages     map[string]LanguageConfig `yaml:",inline"`
}

func GetDefaultConfig

func GetDefaultConfig(getLangDefaultFunc GetLanguageDefaultFunc, langs ...string) (*Config, error)

func Load

func Load(dir string, opts ...Option) (*Config, error)

type Generation

type Generation struct {
	BaseServerURL          string    `yaml:"baseServerUrl,omitempty"`
	Comments               *Comments `yaml:"comments,omitempty"`
	TelemetryEnabled       bool      `yaml:"telemetryEnabled"`
	SDKClassName           string    `yaml:"sdkClassName"`
	TagNamespacingDisabled bool      `yaml:"tagNamespacingDisabled,omitempty"`
	SDKFlattening          bool      `yaml:"sdkFlattening"`
}

type GetLanguageDefaultFunc

type GetLanguageDefaultFunc func(string) (*LanguageConfig, error)

type LanguageConfig

type LanguageConfig struct {
	Version string         `yaml:"version"`
	Cfg     map[string]any `yaml:",inline"`
}

type Management

type Management struct {
	DocChecksum      string `yaml:"docChecksum"`
	DocVersion       string `yaml:"docVersion"`
	SpeakeasyVersion string `yaml:"speakeasyVersion"`
}

type Option

type Option func(*options)

func WithFileSystemFuncs

func WithFileSystemFuncs(rf ReadFileFunc, wf WriteFileFunc) Option

func WithLanguageDefaultFunc

func WithLanguageDefaultFunc(f GetLanguageDefaultFunc) Option

func WithLanguages

func WithLanguages(langs ...string) Option

func WithUpgradeFunc

func WithUpgradeFunc(f UpgradeFunc) Option

type ReadFileFunc

type ReadFileFunc func(filename string) ([]byte, error)

type UpgradeFunc

type UpgradeFunc func(lang, oldVersion, newVersion string, cfg map[string]any) (map[string]any, error)

type WriteFileFunc

type WriteFileFunc func(filename string, data []byte, perm os.FileMode) error