@spec add_issue(t(), term() | [term()]) :: t()

Adds an issue to the issues list. Any issues will prevent writing and be displayed to the user.

@spec add_notice(t(), String.t()) :: t()

Adds a notice to the notices list. Notices are displayed to the user once the igniter finishes running.

Adds a task to the tasks list. Tasks will be run after all changes have been commited

@spec add_warning(t(), term() | [term()]) :: t()

Adds a warning to the warnings list. Warnings will not prevent writing, but will be displayed to the user.

Applies the current changes to the mix.exs in the Igniter and fetches dependencies.

Returns the remaining changes in the Igniter if successful.

Options

• :error_on_abort? - If true, raises an error if the user aborts the operation. Returns the original igniter if not.
• :yes - If true, automatically applies the changes without prompting the user.

@spec assign(t(), atom(), term()) :: t()

Stores the key/value pair in igniter.assigns

@spec changed?(t() | Rewrite.Source.t()) :: boolean()

Returns true if the igniter or source provided has changed

@spec changed?(t(), String.t() | [String.t()]) :: boolean()

Returns true if any of the files specified in paths have changed.

@spec compose_task(
  t(),
  task :: String.t() | module(),
  argv :: [String.t()] | nil,
  fallback :: (t() -> t()) | (t(), [String.t()] -> t()) | nil
) :: t()

Finds the Igniter.Mix.Task task by name and composes it with igniter.

If the task doesn't exist, a fallback function may be provided. This function should accept and return the igniter.

Argument handling

This function calls the task's igniter/1 (or igniter/2) callback, setting igniter.args using the current igniter.args.argv_flags. This prevents composed tasks from accidentally consuming positional arguments. If you wish the composed task to access additional arguments, you must explicitly pass an argv list.

Additionally, you must declare other tasks you are composing with in your task's Igniter.Mix.Task.Info struct using the :composes key. Without this, you'll see unexpected argument errors if a flag that a composed task uses is passed without you explicitly declaring it in your :schema.

Example

def info(_argv, _parent) do
  %Igniter.Mix.Task.Info{
    ...,
    composes: [
      "other.task1",
      "other.task2"
    ]
  }

def igniter(igniter) do
  igniter
  # other.task1 will see igniter.args.argv_flags as its args
  |> Igniter.compose_task("other.task1")
  # other.task2 will see an additional arg and flag
  |> Igniter.compose_task("other.task2", ["arg", "--flag"] ++ igniter.argv.argv_flags)
end

@spec copy_template(
  igniter :: t(),
  source :: Path.t(),
  target :: Path.t(),
  assigns :: Keyword.t(),
  opts :: Keyword.t()
) :: t()

Copies an EEx template file from the source path to the target path.

Accepts the same options as create_new_file/4.

Creates a new file in the project with the provided string contents. Adds an error if it already exists.

Options

• :on_exists - The action to take if the file already exists. Can be
  • :error (default) - Adds an error that prevents any eventual write.
  • :warning - Warns when writing but continues (without overwriting)
  • :skip - Skips writing the file without a warning
  • :overwrite - Warns when writing and overwrites the content with the new content

@spec create_or_update_elixir_file(t(), Path.t(), String.t(), zipper_updater()) :: t()

Creates the given file in the project with the provided string contents, or updates it with a function of type zipper_updater() if it already exists.

Creates the given file in the project with the provided string contents, or updates it with a function as in update_file/3 (or with zipper_updater() for elixir files) if it already exists.

Executes or dry-runs a given Igniter.

@spec exists?(t(), Path.t()) :: boolean()

Checks if a file exists on the file system or in the igniter.

Returns whether the current Igniter has pending changes.

This function stores in the igniter if its been run before, so it is only run once, which is expensive.

@spec include_existing_file(t(), Path.t(), opts :: Keyword.t()) :: t()

Includes the given file in the project, expecting it to exist. Does nothing if its already been added.

@spec include_glob(t(), Path.t() | GlobEx.t()) :: t()

Includes all files matching the given glob, expecting them all (for now) to be elixir files.

@spec include_or_create_file(t(), Path.t(), contents :: String.t()) :: t()

Includes or creates the given file in the project with the provided contents. Does nothing if its already been added.

Installs a package as if calling mix igniter.install

See mix igniter.install for information on the package format.

Options

• append? - If true, appends the package to the existing list of packages instead of prepending. Defaults to false.

Examples

Igniter.install(igniter, "ash")

Igniter.install(igniter, "ash_authentication@2.0", ["--authentication-strategies", "password,magic_link"])

@spec mkdir(t(), Path.t()) :: t()

Creates a folder in the project.

@spec new() :: t()

Returns a new igniter

Runs an update over all elixir files

@spec update_elixir_file(t(), Path.t(), zipper_updater()) :: t()

Updates the source code of the given elixir file

Updates a given file's Rewrite.Source

@spec update_glob(
  t(),
  Path.t() | GlobEx.t(),
  zipper_updater()
) :: t()

Updates all files matching the given glob with the given zipper function.

Adds any new files matching that glob to the igniter first.