View Source Alembic.Config (alembic v0.1.0)
Reads and validates :alembic application configuration.
# config/config.exs
config :alembic,
template_roots: ["priv/templates"],
template_extensions: [".html", ".liquid"],
cache: true,
custom_filters: [],
max_inheritance_depth: 10Summary
Functions
config :alembic, :cache — whether Alembic.Cache is active. Defaults
to true.
config :alembic, :custom_filters — modules implementing
Alembic.Filter, checked before the built-in catalog. Defaults to [].
config :alembic, :max_inheritance_depth — the maximum {% extends %}
chain length before Alembic.Inheritance.resolve_chain/3 returns
{:error, :inheritance_depth_exceeded}. Defaults to 10.
config :alembic, :template_extensions — extensions tried, in order,
when a template name has none. Defaults to [".html", ".liquid"].
config :alembic, :template_roots — the directories Alembic.Loader
searches, in order. Defaults to [].
Validates configuration at application start. Currently just warns when
:template_roots is empty, since that means render_file/3 can never
find a template — a common misconfiguration, not a hard error (an
application that only ever calls render_string/3 has no use for it).
Functions
@spec cache_enabled?() :: boolean()
config :alembic, :cache — whether Alembic.Cache is active. Defaults
to true.
Examples
iex> Application.delete_env(:alembic, :cache)
iex> Alembic.Config.cache_enabled?()
true@spec custom_filters() :: [module()]
config :alembic, :custom_filters — modules implementing
Alembic.Filter, checked before the built-in catalog. Defaults to [].
Examples
iex> Application.delete_env(:alembic, :custom_filters)
iex> Alembic.Config.custom_filters()
[]@spec max_inheritance_depth() :: pos_integer()
config :alembic, :max_inheritance_depth — the maximum {% extends %}
chain length before Alembic.Inheritance.resolve_chain/3 returns
{:error, :inheritance_depth_exceeded}. Defaults to 10.
Examples
iex> Application.delete_env(:alembic, :max_inheritance_depth)
iex> Alembic.Config.max_inheritance_depth()
10@spec template_extensions() :: [String.t()]
config :alembic, :template_extensions — extensions tried, in order,
when a template name has none. Defaults to [".html", ".liquid"].
Examples
iex> Application.delete_env(:alembic, :template_extensions)
iex> Alembic.Config.template_extensions()
[".html", ".liquid"]@spec template_roots() :: [String.t()]
config :alembic, :template_roots — the directories Alembic.Loader
searches, in order. Defaults to [].
Examples
iex> Application.delete_env(:alembic, :template_roots)
iex> Alembic.Config.template_roots()
[]@spec validate!() :: :ok
Validates configuration at application start. Currently just warns when
:template_roots is empty, since that means render_file/3 can never
find a template — a common misconfiguration, not a hard error (an
application that only ever calls render_string/3 has no use for it).
Examples
iex> Alembic.Config.validate!()
:ok