View Source Igniter.Mix.Task.Info (igniter v0.3.4)

Info for an Igniter.Mix.Task, returned from the info/2 callback

Configurable Keys

schema - The option schema for this task, in the format given to OptionParser, i.e [name: :string]
aliases - A map of aliases to the schema keys.
composes - A list of tasks that this task might compose.
installs - A list of dependencies that should be installed before continuing.
adds_deps - A list of dependencies that should be added to the mix.exs, but do not need to be installed before continuing.
extra_args? - Whether or not to allow extra arguments. This forces all tasks that compose this task to allow extra args as well.

Your task should always use switches and not strict to validate provided options!

Summary

Types

t()

Functions

global_options()

Types

t()

@type t() :: %Igniter.Mix.Task.Info{
  adds_deps: [{atom(), String.t()}],
  aliases: Keyword.t(),
  composes: [String.t()],
  extra_args?: boolean(),
  installs: [{atom(), String.t()}],
  schema: Keyword.t()
}