Starter.Runner (starter v0.3.1)

Copy Markdown View Source

Expands and runs a starter's steps against an igniter.

You rarely call this directly — use Starter wires it up for you.

Summary

Functions

installs(starter, opts \\ [])

Returns the packages a run of starter would install, in step order, with optional steps resolved against opts.

run(igniter, starter, opts \\ [])

Runs every step of starter in order, skipping optional steps whose flag is absent from opts.

Functions

installs(starter, opts \\ [])

@spec installs(
  module(),
  keyword()
) :: [atom()]

Returns the packages a run of starter would install, in step order, with optional steps resolved against opts.

These are added to mix.exs and fetched before any step runs, so this is the set whose dependency changes reach disk ahead of the run's diff.

run(igniter, starter, opts \\ [])

@spec run(Igniter.t(), module(), keyword()) :: Igniter.t()

Runs every step of starter in order, skipping optional steps whose flag is absent from opts.

Warns when the target app's Phoenix requirement is older than the supported series (1.8).