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

Structured errors returned by `GitHoox.Config.load/1`.

Errors are tagged tuples (see `t:t/0`) and can be turned into a
human-readable string with `format/1`.

# `t`

```elixir
@type t() ::
  {:missing_config, Path.t()}
  | {:invalid_config, String.t()}
  | {:invalid_stages, [atom()], [atom()]}
  | {:invalid_hook_entry, GitHoox.stage(), term()}
  | {:invalid_hook_module, GitHoox.stage(), term(), String.t()}
  | {:invalid_hook_opts, GitHoox.stage(), module(), String.t()}
```

# `format`

```elixir
@spec format(t()) :: String.t()
```

---

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