Workspace.Graph.Formatter behaviour (Workspace v0.2.1)

A behaviour for defining custom formatters for using with mix workspace.graph.

A formatter is responsible for visualizing the workpsace graph.

Summary

formatter()

A module implementing the Workspace.Graph.Formatter behaviour.

Renders the given workspace graph.

Formats the given workspace using the provided formatter and options.

@type formatter() :: module()

A module implementing the Workspace.Graph.Formatter behaviour.

@callback render(
  graph :: :digraph.graph(),
  workspace :: Workspace.State.t(),
  opts :: keyword()
) :: :ok

Renders the given workspace graph.

The formatter is responsible for printing any console output or generating any output file, based on the given opts.

The graph is expected to be the :digraph.graph() to be printed. The graph may be a subgraph of the full workspace graph.

Options are arbitrary and any formatter can support custom options.

@spec format(
  formatter :: formatter(),
  workspace :: Workspace.State.t(),
  opts :: keyword()
) :: :ok

Formats the given workspace using the provided formatter and options.