mirror of
https://github.com/ash-project/igniter.git
synced 2024-09-20 13:33:00 +12:00
7ae225eee4
improvement: properly find the default location for mix task modules
162 lines
5.3 KiB
Elixir
162 lines
5.3 KiB
Elixir
defmodule Igniter.Mix.Tasks.Igniter.Gen.TaskTest do
|
|
use ExUnit.Case
|
|
import Igniter.Test
|
|
|
|
describe "igniter.gen.task" do
|
|
test "generates a mix task" do
|
|
test_project()
|
|
|> Igniter.compose_task("igniter.gen.task", ["foo.bar"])
|
|
|> assert_creates(
|
|
"lib/mix/tasks/foo.bar.ex",
|
|
"""
|
|
defmodule Mix.Tasks.Foo.Bar do
|
|
use Igniter.Mix.Task
|
|
|
|
@example "mix foo.bar --example arg"
|
|
|
|
@shortdoc "A short description of your task"
|
|
@moduledoc \"\"\"
|
|
Generates a new igniter task
|
|
|
|
Longer explanation of your task
|
|
|
|
## Example
|
|
|
|
```bash
|
|
\#{@example}
|
|
```
|
|
|
|
## Options
|
|
|
|
* `--example-option` or `-e` - Docs for your option
|
|
\"\"\"
|
|
|
|
def info(_argv, _composing_task) do
|
|
%Igniter.Mix.Task.Info{
|
|
# dependencies to add
|
|
adds_deps: [],
|
|
# dependencies to add and call their associated installers, if they exist
|
|
installs: [],
|
|
# An example invocation
|
|
example: @example,
|
|
# Accept additional arguments that are not in your schema
|
|
# Does not guarantee that, when composed, the only options you get are the ones you define
|
|
extra_args?: false,
|
|
# A list of environments that this should be installed in, only relevant if this is an installer.
|
|
only: nil,
|
|
# a list of positional arguments, i.e `[:file]`
|
|
positional: [],
|
|
# Other tasks your task composes using `Igniter.compose_task`, passing in the CLI argv
|
|
# This ensures your option schema includes options from nested tasks
|
|
composes: [],
|
|
# `OptionParser` schema
|
|
schema: [],
|
|
# CLI aliases
|
|
aliases: []
|
|
}
|
|
end
|
|
|
|
def igniter(igniter, argv) do
|
|
# extract positional arguments according to `positional` above
|
|
{arguments, argv} = positional_args!(argv)
|
|
# extract options according to `schema` and `aliases` above
|
|
options = options!(argv)
|
|
|
|
# Do your work here and return an updated igniter
|
|
igniter
|
|
|> Igniter.add_warning("mix foo.bar is not yet implemented")
|
|
end
|
|
end
|
|
"""
|
|
)
|
|
end
|
|
|
|
test "generates a mix task that switches on igniter being compiled with `--optional`" do
|
|
test_project()
|
|
|> Igniter.compose_task("igniter.gen.task", ["foo.bar", "--optional"])
|
|
|> assert_creates(
|
|
"lib/mix/tasks/foo.bar.ex",
|
|
"""
|
|
defmodule Mix.Tasks.Foo.Bar do
|
|
@example "mix foo.bar --example arg"
|
|
|
|
@shortdoc "A short description of your task"
|
|
@shortdoc if Code.ensure_loaded?(Igniter),
|
|
do: "Generates a new igniter task | Install `igniter` to use",
|
|
else: @shortdoc
|
|
|
|
@moduledoc \"\"\"
|
|
Generates a new igniter task
|
|
|
|
Longer explanation of your task
|
|
|
|
## Example
|
|
|
|
```bash
|
|
\#{@example}
|
|
```
|
|
|
|
## Options
|
|
|
|
* `--example-option` or `-e` - Docs for your option
|
|
\"\"\"
|
|
|
|
if Code.ensure_loaded?(Igniter) do
|
|
use Igniter.Mix.Task
|
|
|
|
def info(_argv, _composing_task) do
|
|
%Igniter.Mix.Task.Info{
|
|
# dependencies to add
|
|
adds_deps: [],
|
|
# dependencies to add and call their associated installers, if they exist
|
|
installs: [],
|
|
# An example invocation
|
|
example: @example,
|
|
# Accept additional arguments that are not in your schema
|
|
# Does not guarantee that, when composed, the only options you get are the ones you define
|
|
extra_args?: false,
|
|
# A list of environments that this should be installed in, only relevant if this is an installer.
|
|
only: nil,
|
|
# a list of positional arguments, i.e `[:file]`
|
|
positional: [],
|
|
# Other tasks your task composes using `Igniter.compose_task`, passing in the CLI argv
|
|
# This ensures your option schema includes options from nested tasks
|
|
composes: [],
|
|
# `OptionParser` schema
|
|
schema: [],
|
|
# CLI aliases
|
|
aliases: []
|
|
}
|
|
end
|
|
|
|
def igniter(igniter, argv) do
|
|
# extract positional arguments according to `positional` above
|
|
{arguments, argv} = positional_args!(argv)
|
|
# extract options according to `schema` and `aliases` above
|
|
options = options!(argv)
|
|
|
|
# Do your work here and return an updated igniter
|
|
igniter
|
|
|> Igniter.add_warning("mix foo.bar is not yet implemented")
|
|
end
|
|
else
|
|
use Mix.Task
|
|
|
|
def run(_argv) do
|
|
Mix.shell().error(\"\"\"
|
|
The task 'foo.bar' requires igniter to be run.
|
|
|
|
Please install igniter and try again.
|
|
|
|
For more information, see: https://hexdocs.pm/igniter
|
|
\"\"\")
|
|
|
|
exit({:shutdown, 1})
|
|
end
|
|
end
|
|
end
|
|
"""
|
|
)
|
|
end
|
|
end
|
|
end
|