Module xref_runner

XRef Runner.

Description

XRef Runner. This module is basically copied from rebar's rebar_xref, which in turn borrows heavily from http://github.com/etnt/exrefcheck project as written by Torbjorn Tornkvist, Daniel Luna and others.

Data Types

check()

check() = undefined_function_calls | undefined_functions | locals_not_used | exports_not_used | deprecated_function_calls | deprecated_functions

config()

config() = #{extra_paths => [file:name_all()], xref_defaults => [xref_default()], dirs => [file:name_all()]}

warning()

warning() = #{filename => file:name_all(), line => non_neg_integer(), source => mfa(), target => mfa(), check => check()}

xref_default()

xref_default() = {builtins | recurse | verbose | warnings, boolean()}

Function Index

check/0Runs a list of checks.
check/1
check/2Runs a check on the dirs and with the options provided on Config.
find_dirs/1Returns all dirs under the specified wildcard.

Function Details

check/0

check() -> [warning()]

Runs a list of checks. To decide which checks to run and what options to use, it reads the xref.config file in the current folder expecting it to be something like a regular config file (i.e. [{app_name, [...]}].). The runner will then read the configuration for the xref application. It must contain two (optional) keys: - checks: the list of checks to perform - config: the configuration to use for all of them

check/1

check(Path::file:name_all()) -> [warning()]

check/2

check(Check::check(), Config::config()) -> [warning()]

Runs a check on the dirs and with the options provided on Config.

find_dirs/1

find_dirs(Dirs::[file:name()]) -> [file:filename()]

Returns all dirs under the specified wildcard


Generated by EDoc, May 29 2017, 11:01:48.