1.6.7 Module anvl_project

Handler of ANVL project configurations.

1.6.7.1 Callbacks

init()
-callback init() -> term().

An optional callback that is executed after loading the plugins and project configuration. Project can use it, for example, to install hooks.

conf_override/1
-callback conf_override(dir()) -> lee:patch().

See Project Configuration Override

conf()
-callback conf() -> conf_tree().

See Project Configuration

1.6.7.2 Types

conf_tree()
-type conf_tree() :: #{atom() | [atom()] =>
                           conf_tree() | [conf_tree()] | term()}.
dir()
-type dir() :: file:filename_all().

1.6.7.3 Functions

anvl_includes_dir()
-spec anvl_includes_dir() -> file:filename_all().

Return directory containing anvl.hrl and other ANVL headers.

plugins(Project)
-spec plugins(Project :: dir()) -> [anvl_plugin:t()].
conditions()
root()
-spec root() -> dir().

Return directory of the root project. Root project is the one where anvl was called.

known_projects()
-spec known_projects() -> [dir()].
list_conf(ProjectRoot, Key)
-spec list_conf(dir(), lee:model_key()) -> list().
maybe_conf(ProjectRoot, Key)
-spec maybe_conf(dir(), lee:model_key()) -> {ok,
                                             _Result} |
                                            undefined.
conf(ProjectRoot, Key)
-spec conf(dir(), lee:model_key()) -> _Result.
loaded(Project)
-spec loaded(dir()) -> anvl_condition:t().

JavaScript license information