# `GitHoox.Config`
[🔗](https://github.com/sgerrand/git_hoox/blob/v0.1.0/lib/git_hoox/config.ex#L1)

Load and validate `.git_hoox.exs`.

Validation uses [NimbleOptions](https://hexdocs.pm/nimble_options). Errors
surface as `{:error, reason}` where `reason` is formattable via
`GitHoox.Config.Error.format/1`.

# `load_error`

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

# `default_path`

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

Default config path relative to repo root.

# `load`

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

Load and validate config from `path`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*