MishkaChelekom.Generators.Core (Mishka Chelekom v0.0.9-beta.2)

Copy Markdown View Source

Shared generator plumbing used by the styled (mix mishka.ui.gen.component(s)) and headless (mix mishka.ui.gen.headless) tasks.

The single most important responsibility here is resolving the library's own priv/ directory robustly. The original tasks hardcoded string paths like "deps/mishka_chelekom/priv/components/<name>.eex", which do not exist when the library is consumed as a path: dependency (path deps are not materialised into deps/) or in an umbrella. lib_priv/1 resolves via :code.priv_dir/1 (the canonical, env-agnostic way — already used by MishkaChelekom.Config) and only falls back to the legacy deps/ string when the application priv dir cannot be located.

This change is a pure relocation of where templates/assets are read from; it does not change generated component output (the resolved files are identical for hex-dep installs).

Summary

Functions

lib_priv(sub)

Joins a sub-path onto the library priv/ dir.

lib_priv_dir()

Returns the absolute path to the library's priv/ directory.

template_dir(atom)

The catalog template directories searched for a component name, in priority order.

validate_catalog(config)

Validates that a loaded catalog config has the minimal expected shape, returning {:ok, config} or {:error, reason}. Guards against a malformed .exs silently producing a broken component.

Functions

lib_priv(sub)

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

Joins a sub-path onto the library priv/ dir.

iex> MishkaChelekom.Generators.Core.lib_priv("components/button.eex")

lib_priv_dir()

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

Returns the absolute path to the library's priv/ directory.

Prefers :code.priv_dir(:mishka_chelekom) (works for hex deps, path deps, and umbrellas), falling back to the legacy "deps/mishka_chelekom/priv" string only if the app priv dir is unavailable.

template_dir(atom)

@spec template_dir(:styled | :headless) :: String.t()

The catalog template directories searched for a component name, in priority order.

kind selects the layer:

  • :styled → priv/components
  • :headless → priv/headless

Custom user templates (host-app priv/mishka_chelekom/{components,templates,presets}) are honoured by the styled task via its name-prefix routing and are not affected here.

validate_catalog(config)

@spec validate_catalog(term()) :: {:ok, keyword()} | {:error, String.t()}

Validates that a loaded catalog config has the minimal expected shape, returning {:ok, config} or {:error, reason}. Guards against a malformed .exs silently producing a broken component.