PhoenixMountable.Igniter (PhoenixMountable v0.1.0)

Copy Markdown View Source

Building blocks for a mountable library's Igniter installer.

With them, a library's mix my_lib.install is a few lines:

defmodule Mix.Tasks.MyLib.Install do
  use Igniter.Mix.Task

  @impl Igniter.Mix.Task
  def info(_argv, _parent), do: %Igniter.Mix.Task.Info{group: :my_lib}

  @impl Igniter.Mix.Task
  def igniter(igniter) do
    igniter
    |> PhoenixMountable.Igniter.mount(MyLib.Router, "/my_lib")
    |> PhoenixMountable.Igniter.gen_migration(MyLib.Migrations)
    |> PhoenixMountable.Igniter.add_tailwind_source(:my_lib)
  end
end

Hosts then run mix igniter.install my_lib. Every step is idempotent, so running the installer again changes nothing.

For upgrades, call gen_migration/3 from the library's Igniter upgrader: it writes the migration from the host's pinned version to the latest, or nothing when the host is up to date.

Summary

Functions

add_supervisor(igniter, opts \\ [])

Starts the processes of every mount at boot: adds {PhoenixMountable.Supervisor, router: ..., endpoint: ...} to the host's application, after its endpoint.

add_tailwind_source(igniter, otp_app)

Makes the host's Tailwind scan the library's templates, for libraries styled by the host (PhoenixMountable.Assets.Host).

gen_migration(igniter, migrations, opts \\ [])

Writes the migration that installs the library, or upgrades it from the version the host's migrations pin, to the latest version.

mount(igniter, definition, path, opts \\ [])

Mounts the library in the host's router, inside the scope piped through :browser.

Functions

add_supervisor(igniter, opts \\ [])

@spec add_supervisor(Igniter.t(), keyword()) :: Igniter.t()

Starts the processes of every mount at boot: adds {PhoenixMountable.Supervisor, router: ..., endpoint: ...} to the host's application, after its endpoint.

add_tailwind_source(igniter, otp_app)

@spec add_tailwind_source(Igniter.t(), atom()) :: Igniter.t()

Makes the host's Tailwind scan the library's templates, for libraries styled by the host (PhoenixMountable.Assets.Host).

Tailwind v4 (Phoenix 1.8): adds @source "../../deps/<app>"; to assets/css/app.css. Tailwind v3 (Phoenix 1.7): adds "../deps/<app>/**/*.*ex" to the content of assets/tailwind.config.js.

gen_migration(igniter, migrations, opts \\ [])

@spec gen_migration(Igniter.t(), module(), keyword()) :: Igniter.t()

Writes the migration that installs the library, or upgrades it from the version the host's migrations pin, to the latest version.

Options

  • :repo — the repo (asked, or the only one)
  • :to — the version. Defaults to the latest.

mount(igniter, definition, path, opts \\ [])

@spec mount(Igniter.t(), module(), String.t(), keyword()) :: Igniter.t()

Mounts the library in the host's router, inside the scope piped through :browser.

Options

  • :router — the router (asked, or the only one)
  • :options — mount options, as a string of Elixir code ("resolver: MyApp.MyLibResolver")
  • :pipelines — the pipelines of the scope. Defaults to [:browser].