Dependents.Tree (Dependents Tree v0.1.36)

View Source

Converts the Dependents.Tree of all or a single app into table maps.

The dependencies of an app are specified in the mix.exs file. The dependents of an app are those apps using it as a dependency.

Summary

Types

Local app

Number of local dependencies

Local dependent

Number of local dependents

Topological rank

Ranks of topologically ordered apps

t()

Tree mapping local apps to local dependents

Table map for printing

Functions

Returns the projects directory as set by environment variable PROJEX_DIR.

Converts the Dependents.Tree of all or a single app into table maps.

Types

app()

@type app() :: Application.app()

Local app

dcys()

@type dcys() :: non_neg_integer()

Number of local dependencies

dep()

@type dep() :: Application.app()

Local dependent

deps()

@type deps() :: non_neg_integer()

Number of local dependents

rank()

@type rank() :: pos_integer()

Topological rank

ranks()

@type ranks() :: %{required(app()) => rank()}

Ranks of topologically ordered apps

t()

@type t() :: %{required(app()) => [dcys() | dep()]}

Tree mapping local apps to local dependents

table_map()

@type table_map() :: %{
  rank: rank(),
  chunk: pos_integer(),
  ver: String.t() | nil,
  hex: String.t() | nil,
  app: app() | nil,
  dcys: dcys() | nil,
  deps: deps() | nil,
  dependent_1: dep() | nil,
  dependent_2: dep() | nil,
  dependent_3: dep() | nil,
  dependent_4: dep() | nil
}

Table map for printing

Functions

new()

@spec new() :: t()

See Dependents.Tree.Proxy.new/0.

projects_dir()

@spec projects_dir() :: String.t()

Returns the projects directory as set by environment variable PROJEX_DIR.

to_maps(app)

@spec to_maps(:* | app()) :: [table_map()]

Converts the Dependents.Tree of all or a single app into table maps.

to_maps(tree, ranks)

@spec to_maps(t(), ranks()) :: [table_map()]

See Dependents.Tree.Proxy.to_maps/2.