mirror of
https://github.com/ash-project/igniter.git
synced 2024-09-20 05:22:52 +12:00
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
|
# Writing Generators
|
||
|
|
|
||
|
|
In `Igniter`, generators are done as a wrapper around `Mix.Task`, allowing them to be called individually or composed as part of a task. Since an example is worth a thousand words, lets take a look at an example that generates a file and ensures a configuration is set in the user's `config.exs`.
|
||
|
|
|
||
|
|
```elixir
|
||
|
|
# lib/mix/tasks/your_lib.gen.your_thing.ex
|
||
|
|
defmodule Mix.Tasks.YourLib.Gen.YourThing do
|
||
|
|
use Igniter.Mix.Task
|
||
|
|
|
||
|
|
def igniter(igniter, [module_name | _ ] = argv) do
|
||
|
|
module_name = Igniter.Module.parse(module_name)
|
||
|
|
path = Igniter.Module.proper_location(module_name)
|
||
|
|
app_name = Igniter.Application.app_name()
|
||
|
|
|
||
|
|
igniter
|
||
|
|
|> Igniter.create_new_elixir_file(igniter, path, """
|
||
|
|
defmodule #{inspect(module_name)} do
|
||
|
|
use YourLib.Thing
|
||
|
|
|
||
|
|
...some_code
|
||
|
|
end
|
||
|
|
""")
|
||
|
|
|> Igniter.Config.configure(
|
||
|
|
"config.exs",
|
||
|
|
app_name,
|
||
|
|
[:list_of_things],
|
||
|
|
[module_name],
|
||
|
|
&Igniter.Code.List.prepend_new_to_list(&1, module_name)
|
||
|
|
)
|
||
|
|
end
|
||
|
|
end
|
||
|
|
```
|
||
|
|
|
||
|
|
Now, your users can run
|
||
|
|
|
||
|
|
`mix your_lib.gen.your_thing MyApp.MyModuleName`
|
||
|
|
|
||
|
|
and it will present them with a diff, creating a new file and updating their `config.exs`.
|
||
|
|
|
||
|
|
Additionally, other generators can "compose" this generator using `Igniter.compose_task/3`
|
||
|
|
|
||
|
|
```elixir
|
||
|
|
igniter
|
||
|
|
|> Igniter.compose_task(Mix.Tasks.YourLib.Gen.YourThing, ["MyApp.MyModuleName"])
|
||
|
|
|> Igniter.compose_task(Mix.Tasks.YourLib.Gen.YourThing, ["MyApp.SomeOtherName"])
|
||
|
|
```
|
||
|
|
|
||
|
|
## Writing a library installer
|
||
|
|
|
||
|
|
Igniter will look for a mix task called `your_library.install` when a user runs `mix igniter.install your_library`. As long as it has the correct name, it will be run automatically as part of installation!
|