@spec apply_igniter(Igniter.t()) ::
  {:ok, Igniter.t(),
   %{
     tasks: [{String.t(), [String.t()]}],
     warnings: [String.t()],
     notices: [String.t()]
   }}
  | {:error, [String.t()]}

Fakes applying the changes of an igniter.

This function returns any tasks, errors, warnings.

@spec apply_igniter!(Igniter.t()) :: Igniter.t() | no_return()

Applies an igniter, raising an error if there are any issues.

See apply_igniter/1 for more.

@spec diff(Igniter.t(), opts :: Keyword.t()) :: String.t()

Return the current igniter diff.

Options

• :only - Only return the diff for this file or files

@spec puts_diff(Igniter.t(), opts :: Keyword.t()) :: Igniter.t()

Print the current igniter diff, returning the igniter.

This is primarily used for debugging purposes.

Options

• :label - A label to print before the diff
• :only - Only print the diff for this file or files

@spec test_project(opts :: Keyword.t()) :: Igniter.t()

Sets up a test igniter that has only the files passed to it.

Starting point

All of the files of an empty mix project are added by default. You can specify more or overwrite files with the :files option.

Limitations

You cannot install new dependencies, or use dependencies your own project does not have. If you need to do that kind of thing, you will have to do a test that uses tools like System.cmd in a temporary directory.

Options

• files - A map of file paths to file contents. The file paths should be relative to the project root.
• app_name - The name of the application. Defaults to :test.

Examples

test_project(files: %{
  "lib/foo.ex" => """
  defmodule MyApp.Foo do
    use Ash.Resource
  end
  """
})