Module rebar_config

Function Index

consult/1reads the default config file in a given directory.
consult_app_file/1reads a given app file, including the .script variations, if any can be found.
consult_file/1reads a given config file, including the .script variations, if any can be found, and asserts that the config format is in a key-value format.
consult_lock_file/1reads the lock file for the project, and re-formats its content to match the internals for rebar3.
consult_root/0reads the default config file at the top of a full project.
format_error/1convert a given exception's payload into an io description.
maybe_write_lock_file/3
merge_locks/2takes an existing configuration and the content of a lockfile and merges the locks into the config.
write_lock_file/2Converts the internal format for locks into the multi-version compatible one used within rebar3 lock files.

Function Details

consult/1

consult(Dir::file:name()) -> [any()]

reads the default config file in a given directory.

consult_app_file/1

consult_app_file(File::file:filename()) -> [any()]

reads a given app file, including the .script variations, if any can be found.

consult_file/1

consult_file(File::file:filename()) -> [{term(), term()}]

reads a given config file, including the .script variations, if any can be found, and asserts that the config format is in a key-value format.

consult_lock_file/1

consult_lock_file(File::file:filename()) -> [any()]

reads the lock file for the project, and re-formats its content to match the internals for rebar3.

consult_root/0

consult_root() -> [any()]

reads the default config file at the top of a full project

format_error/1

format_error(X1::any()) -> iolist()

convert a given exception's payload into an io description.

maybe_write_lock_file/3

maybe_write_lock_file(LockFile, Locks, OldLocks) -> any()

merge_locks/2

merge_locks(Config::[{term(), term()}], Locks::list()) -> [{term(), term()}]

takes an existing configuration and the content of a lockfile and merges the locks into the config.

write_lock_file/2

write_lock_file(LockFile::file:filename(), Locks::[any()]) -> ok | {error, term()}

Converts the internal format for locks into the multi-version compatible one used within rebar3 lock files.


Generated by EDoc