GitHoox.Config (GitHoox v0.1.0)

Copy Markdown View Source

Load and validate .git_hoox.exs.

Validation uses NimbleOptions. Errors surface as {:error, reason} where reason is formattable via GitHoox.Config.Error.format/1.

Summary

Functions

Default config path relative to repo root.

Load and validate config from path.

Types

load_error()

@type load_error() :: GitHoox.Config.Error.t()

Functions

default_path()

@spec default_path() :: Path.t()

Default config path relative to repo root.

load(path \\ ".git_hoox.exs")

@spec load(Path.t()) :: {:ok, GitHoox.config()} | {:error, load_error()}

Load and validate config from path.