GitHoox.Config.Error (GitHoox v0.1.0)

Copy Markdown View Source

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

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

Summary

Types

t()

@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()}

Functions

format(arg)

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