Definitively.Init (definitively v0.4.1)

Copy Markdown

Scaffolds a .definitively/ workspace by copying packaged templates.

Uses priv/templates/definitively/ when present (Mix dev/test). Escript installs fall back to compile-time embedded templates because escripts do not ship priv/.

Summary

Functions

Copies template files into <workspace>/.definitively/.

Functions

run(opts \\ [])

@spec run(keyword()) ::
  {:ok, %{created: [Path.t()], skipped: [Path.t()]}} | {:error, term()}

Copies template files into <workspace>/.definitively/.

Workspace root is DEFINITIVELY_WORKSPACE when set, otherwise the current working directory. Existing destination files are skipped unless force: true (CLI --force).

Options

  • :force — overwrite existing destination files
  • :workspace_root — override workspace root (tests)
  • :templates_source:filesystem or :embedded to force a source (tests)