W3cubDocs

/Elixir 1.11

Mix.Generator

Conveniences for working with paths and generating content.

Summary

Functions

copy_file(source, target, options \\ []): Copies source to target.
copy_template(source, target, assigns, options \\ []): Evaluates and copy templates at source to target.
create_directory(path, options \\ []): Creates a directory if one does not exist yet.
create_file(path, contents, opts \\ []): Creates a file with the given contents.
embed_template(name, contents): Embeds a template given by contents into the current module.
embed_text(name, contents): Embeds a text given by contents into the current module.
overwrite?(path): Prompts the user to overwrite the file if it exists.
overwrite?(path, contents): Prompts the user to overwrite the file if it exists.

Functions

copy_file(source, target, options \\ [])

Specs

copy_file(Path.t(), Path.t(), keyword()) :: boolean()

Copies source to target.

If target already exists and the contents are not the same, it asks for user confirmation.

Options

:force - forces copying without a shell prompt
:quiet - does not log command output

Examples

iex> Mix.Generator.copy_file("source/gitignore", ".gitignore")
* creating .gitignore
true

copy_template(source, target, assigns, options \\ [])

Specs

copy_template(Path.t(), Path.t(), keyword(), keyword()) :: boolean()

Evaluates and copy templates at source to target.

The template in source is evaluated with the given assigns.

If target already exists and the contents are not the same, it asks for user confirmation.

Options

:force - forces copying without a shell prompt
:quiet - does not log command output

Examples

iex> assigns = [project_path: "/Users/joe/newproject"]
iex> Mix.Generator.copy_template("source/gitignore", ".gitignore", assigns)
* creating .gitignore
true

create_directory(path, options \\ [])

Specs

create_directory(Path.t(), keyword()) :: true

Creates a directory if one does not exist yet.

This function does nothing if the given directory already exists; in this case, it still logs the directory creation.

Options

:quiet - does not log command output

Examples

iex> Mix.Generator.create_directory("path/to/dir")
* creating path/to/dir
true

create_file(path, contents, opts \\ [])

Specs

create_file(Path.t(), iodata(), keyword()) :: boolean()

Creates a file with the given contents.

If the file already exists and the contents are not the same, it asks for user confirmation.

Options

:force - forces creation without a shell prompt
:quiet - does not log command output

Examples

iex> Mix.Generator.create_file(".gitignore", "_build\ndeps\n")
* creating .gitignore
true

embed_template(name, contents)

Embeds a template given by contents into the current module.

It will define a private function with the name followed by _template that expects assigns as arguments.

This function must be invoked passing a keyword list. Each key in the keyword list can be accessed in the template using the @ macro.

For more information, check EEx.SmartEngine.

Examples

defmodule Mix.Tasks.MyTask do
  require Mix.Generator
  Mix.Generator.embed_template(:log, "Log: <%= @log %>")
end

embed_text(name, contents)

Embeds a text given by contents into the current module.

It will define a private function with the name followed by _text that expects no arguments.

Examples

defmodule Mix.Tasks.MyTask do
  require Mix.Generator
  Mix.Generator.embed_text(:error, "There was an error!")
end

overwrite?(path)

Specs

overwrite?(Path.t()) :: boolean()

Prompts the user to overwrite the file if it exists.

Returns false if the file exists and the user forbade to override it. Returns true otherwise.

overwrite?(path, contents)

Specs

overwrite?(Path.t(), iodata()) :: boolean()

Prompts the user to overwrite the file if it exists.

The contents are compared to avoid asking the user to override if the contents did not change. Returns false if the file exists and the content is the same or the user forbade to override it. Returns true otherwise.