Starter.Steps (starter v0.1.1)

Copy Markdown View Source

Registry of Starter's built-in steps.

Steps are discovered by module naming convention:

  • :add steps live under Mix.Tasks.Starter.Add.*
  • :remove steps live under Mix.Tasks.Starter.Remove.*
  • :gen steps live under Mix.Tasks.Starter.Gen.*

A step's short name is the underscored form of its last module segment, so Mix.Tasks.Starter.Add.Oban resolves from {:add, :oban}.

Summary

Functions

kinds()

The step kinds Starter knows about.

modules(kind)

Returns all step modules of the given kind.

name(module)

Returns the short name of a step module (e.g. "oban").

names(kind)

Returns the short names of all steps of the given kind.

resolve(kind, name)

Resolves a short name to a step module.

Functions

kinds()

The step kinds Starter knows about.

modules(kind)

Returns all step modules of the given kind.

name(module)

Returns the short name of a step module (e.g. "oban").

names(kind)

Returns the short names of all steps of the given kind.

resolve(kind, name)

Resolves a short name to a step module.

Matching is forgiving about case, underscores, and dashes, so :daisy_ui, "daisyui", and "daisy-ui" all resolve to the same step.