View Source Igniter (igniter v0.3.11)

Tools for generating and patching code into an Elixir project.

Summary

Types

t()

zipper_updater()

Functions

add_issue(igniter, issue)

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

add_task(igniter, task, argv \\ [])

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

add_warning(igniter, warning)

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

apply_and_fetch_dependencies(igniter, opts \\ [])

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

assign(igniter, key_vals)

assign(igniter, key, value)

Stores the key/value pair in igniter.assigns

compose_task(igniter, task, argv \\ [], fallback \\ nil)

Finds the Igniter.Mix.Task task by name and composes it (calls its igniter/2) into the current igniter. If the task doesn't exist, a fallback implementation may be provided as the last argument.

create_new_elixir_file(igniter, path, contents \\ "")

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

create_or_update_elixir_file(igniter, path, contents, updater)

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.

do_or_dry_run(igniter, opts \\ [])

Executes or dry-runs a given Igniter.

exists?(igniter, path)

has_changes?(igniter, paths \\ nil)

Returns whether the current Igniter has pending changes.

include_all_elixir_files(igniter)

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

include_existing_elixir_file(igniter, path, opts \\ [])

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

include_existing_file(igniter, path, opts \\ [])

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

include_glob(igniter, glob)

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

include_or_create_elixir_file(igniter, path, contents \\ "")

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

move_file(igniter, from, from, opts \\ [])

new()

Returns a new igniter

update_assign(igniter, key, default, fun)

update_elixir_file(igniter, path, func)

Updates the source code of the given elixir file

update_file(igniter, path, updater)

Updates a given file's Rewrite.Source

update_glob(igniter, glob, func)

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

Types

t()

@type t() :: %Igniter{
  assigns: map(),
  issues: [String.t()],
  moves: %{optional(String.t()) => String.t()},
  rewrite: Rewrite.t(),
  tasks: [{String.t() | [String.t()]}],
  warnings: [String.t()]
}

zipper_updater()

@type zipper_updater() :: (Sourceror.Zipper.t() ->
                       {:ok, Sourceror.Zipper.t()}
                       | {:error, String.t() | [String.t()]})

Functions

add_issue(igniter, issue)

@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.

add_task(igniter, task, argv \\ [])

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

add_warning(igniter, warning)

@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.

apply_and_fetch_dependencies(igniter, opts \\ [])

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.

assign(igniter, key_vals)

assign(igniter, key, value)

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

Stores the key/value pair in igniter.assigns

compose_task(igniter, task, argv \\ [], fallback \\ nil)

Finds the Igniter.Mix.Task task by name and composes it (calls its igniter/2) into the current igniter. If the task doesn't exist, a fallback implementation may be provided as the last argument.

create_new_elixir_file(igniter, path, contents \\ "")

@spec create_new_elixir_file(t(), Path.t(), String.t()) :: t()

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

create_or_update_elixir_file(igniter, path, contents, updater)

@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.

do_or_dry_run(igniter, opts \\ [])

Executes or dry-runs a given Igniter.

exists?(igniter, path)

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

has_changes?(igniter, paths \\ nil)

Returns whether the current Igniter has pending changes.

include_all_elixir_files(igniter)

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

include_existing_elixir_file(igniter, path, opts \\ [])

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

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

include_existing_file(igniter, path, opts \\ [])

@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.

include_glob(igniter, glob)

@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.

include_or_create_elixir_file(igniter, path, contents \\ "")

@spec include_or_create_elixir_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.

move_file(igniter, from, from, opts \\ [])

new()

@spec new() :: t()

Returns a new igniter

update_assign(igniter, key, default, fun)

update_elixir_file(igniter, path, func)

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

Updates the source code of the given elixir file

update_file(igniter, path, updater)

@spec update_file(t(), Path.t(), (Rewrite.Source.t() -> Rewrite.Source.t())) :: t()

Updates a given file's Rewrite.Source

update_glob(igniter, glob, func)

@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.