Current section
Files
Jump to
Current section
Files
lib/mix/tasks/uikit.install.ex
defmodule Mix.Tasks.Uikit.Install.Docs do
@moduledoc false
@spec short_doc() :: String.t()
def short_doc do
"A short description of your task"
end
@spec example() :: String.t()
def example do
"mix uikit.install --example arg"
end
@spec long_doc() :: String.t()
def long_doc do
"""
#{short_doc()}
Longer explanation of your task
## Example
```sh
#{example()}
```
## Options
* `--example-option` or `-e` - Docs for your option
"""
end
end
if Code.ensure_loaded?(Igniter) do
defmodule Mix.Tasks.Uikit.Install do
@shortdoc "#{__MODULE__.Docs.short_doc()}"
@moduledoc __MODULE__.Docs.long_doc()
use Igniter.Mix.Task
@impl Igniter.Mix.Task
def info(_argv, _composing_task) do
%Igniter.Mix.Task.Info{
# Groups allow for overlapping arguments for tasks by the same author
# See the generators guide for more.
group: :uikit,
# *other* dependencies to add
# i.e `{:foo, "~> 2.0"}`
adds_deps: [],
# *other* dependencies to add and call their associated installers, if they exist
# i.e `{:foo, "~> 2.0"}`
installs: [],
# An example invocation
example: __MODULE__.Docs.example(),
# A list of environments that this should be installed in.
only: [:dev],
# 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: [],
# Default values for the options in the `schema`
defaults: [],
# CLI aliases
aliases: [],
# A list of options in the schema that are required
required: []
}
end
@impl Igniter.Mix.Task
def igniter(igniter) do
# Do your work here and return an updated igniter
igniter
|> Igniter.add_notice("Add @import ... to your app.css etc.")
|> Igniter.add_warning("mix uikit.install is not yet implemented")
end
end
else
defmodule Mix.Tasks.Uikit.Install do
@shortdoc "#{__MODULE__.Docs.short_doc()} | Install `igniter` to use"
@moduledoc __MODULE__.Docs.long_doc()
use Mix.Task
@impl Mix.Task
def run(_argv) do
Mix.shell().error("""
The task 'uikit.install' requires igniter. Please install igniter and try again.
For more information, see: https://hexdocs.pm/igniter/readme.html#installation
""")
exit({:shutdown, 1})
end
end
end