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.

Showing Posts 1 to 1

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
itzmidinesh
Hi all, I’m working on a Phoenix project where I need to make external HTTP requests and I’m trying to choose between Req and HTTPoison....
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
leoschweizer
Hi, we run different LLM models across a cluster, with each node loading a configurable subset. Model-specific queues let nodes consume ...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New
saleyn
Is there a way to import record definitions in the iex shell for pretty printing (similar to the rr command in the erl shell)? This woul...
New
rlipscombe
When I use Mix.install with a git dependency, using git@github.com:... how do I change the SSH identity used? I’ve got two Github accoun...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
KristerV
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews