`mix phx.routes` equivalent for AshJsonApi?

shankardevy · August 17, 2024, 7:26am

I know there is AshJsonApi.Resource.Info.routes/2 as documented here to get the list of routes per resource inside a single domain. However, wouldn’t it be nice to have a mix task like mix phx.routes to list all routes available for all domains?

Would something like this is in the roadmap for the Ash team and would you be willing to accept a PR?

zachdaniel · August 17, 2024, 3:05pm

I’m happy to accept a PR for this, but one thing to keep in mind is that it will need to support two modes potentially, one based off of phoenix and one based off of plug. Alternatively, we could just have it fail if phoenix is not available.

For a template on how to do this, you can see the mix ash_authentication_phoenix.routes code. Just remember to conditionally compile it based on the presence of Phoenix, since ash_json_api does not depend on phoenix.

github.com

team-alembic/ash_authentication_phoenix/blob/main/lib/mix/tasks/ash_authentication.phoenix.routes.ex

defmodule Mix.Tasks.AshAuthentication.Phoenix.Routes do
  use Mix.Task

  alias AshAuthentication.Phoenix.Router.ConsoleFormatter

  @moduledoc """
  Prints all routes pertaining to AshAuthenticationPhoenix for the default or a given router.

  This task can be called directly, accepting the same options as `mix phx.routes`, except for `--info`.

  Alternatively, you can modify your aliases task to run them back to back it.

  ```elixir
  aliases: ["phx.routes": ["do", "phx.routes,", "ash_authentication.phx.routes"]]
  ```
  """

  @shortdoc "Prints all routes generated by AshAuthentication Phoenix"
  @impl true
  def run(args, base \\ Mix.Phoenix.base()) do

This file has been truncated. show original