Packages

Extractly `mix xtra` task to render `EEx` templates with easy access to hexdocs. The Extractly module gives easy access to Elixir metainformation of the application using the extractly package, notably, module and function documentation.

Current section

Files

Jump to
extractly lib tasks xtra.help.ex
Raw

lib/tasks/xtra.help.ex

defmodule Mix.Tasks.Xtra.Help do
use Mix.Task
@shortdoc "Explains availabe xtra subtasks"
@moduledoc """
### Usage:
mix xtra [options]... [template]
#### Options:
--help | -h Prints short help information to stdout and exits.
--quiet | -q No output to stdout or stderr
--version | -v Prints the current version to stdout and exits.
--verbose | -V Prints additional output to stderr
--output filename
The name of the file the rendered template is written to, defaults to the templates'
name, without the suffix `.eex`
#### Argument:
template, filename of the `EEx` template to use, defaults to `"README.md.eex"`
"""
@impl true
def run(_args) do
IO.puts :stderr, Extractly.Xtra.moduledoc(to_string(__MODULE__))
end
end