blueprint v0.3.0 mix blueprint.plot.mod

Creates a module graph.

mix blueprint.plot.mod [APP] [--simple | --complex] [--colour] [--messages] [--version] [[--lib LIB | --path PATH] ...] [--servers FILE] [-o PATH]

An APP name is provided if the module graph should be limited to the given application. Otherwise it will be for the entire blueprint (libraries tracked).

A --simple or --complex option can be used to indicate the detail of the generated graph.

A --colour option can be used to generate a coloured graph.

A --messages option can be used to generate connections for messages sent between modules.

A --version option can be used to include version numbers in the module nodes.

A -o option can be used to specify the file to be written.

As many --lib or --path options can be provided to add additional libraries to the blueprint. If none are provided, the blueprint will default to using the libraries found in the project’s build directory.

A --servers option can be used to specify the file to be used for custom server matching expressions. For more information see Blueprint.Application.Module. However this file is expected to be elixir, rather than a string.

## Examples

Generate a graph for the current project:

mix blueprint.plot.mod

Generate a graph for the current project’s example application:

mix blueprint.plot.mod example

Generate a graph for the provided libraries:

mix blueprint.plot.mod --lib example1 --lib example2 --path /example

Generate a simple graph of mnesia from the standard erlang runtime:

mix blueprint.plot.mod --path $(elixir -e 'IO.puts :code.lib_dir') --simple mnesia

Link to this section Summary

Functions

A task needs to implement run which receives a list of command line args

Link to this section Functions

A task needs to implement run which receives a list of command line args.

Callback implementation for Mix.Task.run/1.