config

Documentation

Overview

Package config contains the structure of the gotools config file, along with helpers.

Index

• func DefaultVersion(file string) (string, error)
• type Config
  • func Load(file string) (Config, error)
• type ExerciseVersion
• type TestFileConfig
• type VersionConfig
  • func (vc *VersionConfig) ExerciseExpectedVersion(exercise string) string

Functions

func DefaultVersion

func DefaultVersion(file string) (string, error)

Return the default go.mod version from a config.

Types

type Config

type Config struct {
	GoModVersion VersionConfig  `json:"go_mod_version"`
	TestFiles    TestFileConfig `json:"test_files"`
}

func Load

func Load(file string) (Config, error)

Load loads a configuration from a path to a JSON file.

type ExerciseVersion

type ExerciseVersion struct {
	Exercise string `json:"exercise"`
	Version  string `json:"version"`
}

ExerciseVersion represents the version one particular exercise should have in its go.mod file

type TestFileConfig

type TestFileConfig struct {
	Exclude map[string][]string `json:"exclude"`
}

type VersionConfig

type VersionConfig struct {
	// Default version for the go.mod files
	Default string `json:"default"`
	// List of exercises and their versions that must not have
	// the default version.
	Exceptions []ExerciseVersion `json:"exceptions"`
}

VersionConfig represents the version configuration

func (*VersionConfig) ExerciseExpectedVersion

func (vc *VersionConfig) ExerciseExpectedVersion(exercise string) string

ExerciseExpectedVersion gives the expected version the go.mod file for an exercise should be at. The argument should be the slug of an exercise.