Module rebar_app_discover

utility functions to do the basic discovery of apps and layout for the project.

Description

utility functions to do the basic discovery of apps and layout for the project.

Function Index

do/2from the base directory, find all the applications at the top level and their dependencies based on the configuration and profile information.
find_app/3check that a given app in a directory is there, and whether it's valid or not based on the second argument.
find_app/4check that a given app in a directory is there, and whether it's valid or not based on the second argument.
find_apps/2for each directory passed, find all apps that are valid.
find_apps/3for each directory passed, find all apps according to the validity rule passed in.
find_apps/4for each directory passed, with the configured source directories, find all apps according to the validity rule passed in.
find_unbuilt_apps/2find all apps that haven't been built in a list of directories.
format_error/1formatting errors from the module.

Function Details

do/2

do(State::rebar_state:t(), LibDirs::[file:filename()]) -> rebar_state:t() | no_return()

from the base directory, find all the applications at the top level and their dependencies based on the configuration and profile information.

find_app/3

find_app(AppDir::file:filename_all(), Validate::valid | invalid | all, State::rebar_state:t()) -> {true, rebar_app_info:t()} | false

check that a given app in a directory is there, and whether it's valid or not based on the second argument. Returns the related app info record.

find_app/4

find_app(AppInfo::rebar_app_info:t(), AppDir::file:filename_all(), Validate::valid | invalid | all, State::rebar_state:t()) -> {true, rebar_app_info:t()} | false

check that a given app in a directory is there, and whether it's valid or not based on the second argument. Returns the related app info record.

find_apps/2

find_apps(LibDirs::[file:filename_all()], State::rebar_state:t()) -> [rebar_app_info:t()]

for each directory passed, find all apps that are valid. Returns all the related app info records.

find_apps/3

find_apps(LibDirs::[file:filename_all()], Validate::valid | invalid | all, State::rebar_state:t()) -> [rebar_app_info:t()]

for each directory passed, find all apps according to the validity rule passed in. Returns all the related app info records.

find_apps/4

find_apps(LibDirs::[file:filename_all()], SrcDirs::[file:filename_all()], Validate::valid | invalid | all, State::rebar_state:t()) -> [rebar_app_info:t()]

for each directory passed, with the configured source directories, find all apps according to the validity rule passed in. Returns all the related app info records.

find_unbuilt_apps/2

find_unbuilt_apps(LibDirs::[file:filename_all()], State::rebar_state:t()) -> [rebar_app_info:t()]

find all apps that haven't been built in a list of directories

format_error/1

format_error(Error::term()) -> iodata()

formatting errors from the module.


Generated by EDoc