gilbertbw
Runtime Mix.Task - set long task description?
I have a Mix.Task I am writing. This is a generic Task runner task, where what it does depends entirely on the project configuration. As such I want running mix help check to use a runtime set long task description.
With a configuration like this:
def project do
[
#...
checks: [
{"test", "mix", ~W"test --force --warnings-as-errors"},
{"cspell", "npx", ~W"--package=cspell@8.16.0 --yes -- cspell ."},
{"compile (no warnings)", "mix", ~W"compile --force --warnings-as-errors"},
]
#...
]
#...
I want to show this as the help
Runs the following checks:
- test
- cspell
- compile (no warnings)
I expect doing this would require getting Mix.Task.moduledoc changed to optionally call a callback on the task?
Alternatively if anyone knows of a better way to do what I am doing I am all ears. I believe I can not use an alias, both because I want to call external commands, and because I want to e.g. run test in the test enironment, then compile in the dev environment.
First Post!
harrisi
I think you can probably do this with Mix.Project.config/0. Something like:
defmodule Mix.Tasks.CheckHelper do
def build_help do
checks = Mix.Project.config()
|> Keyword.get(:checks)
|> Enum.map(fn el -> elem(el, 0) end)
|> Enum.join("\n\n")
{0, checks}
end
end
defmodule Mix.Tasks.Check do
use Mix.Task
alias Mix.Tasks.CheckHelper
Module.put_attribute(__MODULE__, :moduledoc, CheckHelper.build_help())
@impl Mix.Task
def run(_args) do
Mix.shell().info("use `mix help check`")
end
end
$ mix check && mix help check
mix check
test
cspell
compile (no warnings)
I don’t think this is ideal, but it’s a starting point, hopefully. Or it’s bad enough that someone will correct it for an actual solution.
Popular in Questions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Enabling companies to succeed by building software people love.
Categories:
Sub Categories:
Forums
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Practical resources that improve the lives of professional developers.
Develop your skills with books, videos, and courses.
Producing high quality Elixir screencasts since 2017.
Courses that'll move you from confusion to "Aha, now I get it!"