LemonCore.Quality.ArchitectureDocs (lemon_core v0.1.0)

Renders and validates the generated dependency-policy section in the architecture boundaries document.

Summary

issue()

report()

check(root)

generate(root)

write(root)

@type issue() :: %{code: atom(), message: String.t(), path: String.t() | nil}

@type report() :: %{
  root: String.t(),
  issue_count: non_neg_integer(),
  issues: [issue()]
}

@spec check(String.t()) :: {:ok, report()} | {:error, report()}

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

@spec generate(String.t()) :: {:ok, String.t(), String.t()} | {:error, issue()}

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

@spec replace_generated_section(String.t(), String.t()) ::
  {:ok, String.t()} | {:error, issue()}

@spec write(String.t()) :: :ok | {:error, issue()}