LemonCore.Quality.DocsCatalog (lemon_core v0.1.0)

Loads and validates docs catalog metadata used by quality checks.

Summary

Types

entry()

Functions

catalog_file(root)

load(opts \\ [])

Types

entry()

@type entry() :: %{
  :path => String.t(),
  :owner => String.t(),
  :last_reviewed => Date.t(),
  :max_age_days => pos_integer(),
  optional(atom()) => any()
}

Functions

catalog_file(root)

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

load(opts \\ [])

@spec load(keyword()) :: {:ok, [entry()]} | {:error, String.t()}