config

package

v0.0.1 Latest Latest Go to latest Published: Feb 19, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const CONFIG_FILE_DEFAULT = "~/.config/scriv/config.json"

View Source

const CONFIG_FILE_ENV_OVERRIDE = "SCRIV_CONFIG"

This section is empty.

func ConfigFilePath() string

Determine the path to the configuration file, as it may be overridden by an environment variable

func WithConfig(ctx context.Context, config Config) context.Context

Add the configuration to the context

type Config struct {
	Paths    []PathEntry
	Settings Settings
	Logger   *slog.Logger
}

The main configuration object

func GetConfig(ctx context.Context) Config

Get the configuration from the context

func InitConfig() Config

Initialize the entire configuration

type ConfigKey struct{}

The key struct for accesing the config object in the context

type PathEntry struct {
	Path  string
	Depth int
}

Defines a single Path under which to search for repositories

type Settings struct {
	Ignore []string
}

General configuration settings