Igniter.Mix.Task behaviour (igniter v0.1.2)

A behaviour for implementing a Mix task that is enriched to be composable with other Igniter tasks.

Summary

Callbacks

All the generator behavior happens here, you take an igniter and task arguments, and return an igniter.

Whether or not it supports being run in the root of an umbrella project

Callbacks

Link to this callback

igniter(igniter, argv)

@callback igniter(igniter :: Igniter.t(), argv :: [String.t()]) :: Igniter.t()

All the generator behavior happens here, you take an igniter and task arguments, and return an igniter.

Link to this callback

supports_umbrella?()

@callback supports_umbrella?() :: boolean()

Whether or not it supports being run in the root of an umbrella project

At the moment, this is still experimental and we suggest not turning it on.