PhoenixDiagrams.Loader (phoenix_diagrams v0.2.3)

Copy Markdown View Source

Scans a directory of .exs diagram metadata files and reads each one's referenced .mmd source into a list of entry maps.

Summary

Types

entry()

@type entry() :: %{
  key: String.t(),
  group: String.t(),
  name: String.t(),
  source: String.t(),
  type: :mermaid | :plantuml
}

error_entry()

@type error_entry() :: %{
  key: String.t(),
  group: String.t() | nil,
  name: String.t() | nil,
  error: String.t(),
  file: String.t()
}

Functions

scan(path)

@spec scan(String.t()) :: [entry() | error_entry()]