gilbertbw

gilbertbw

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! Switch mode

harrisi

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.

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New

We're in Beta

About us Mission Statement