mix composer.recipe.show (composer v0.2.0)

Copy Markdown View Source

Shows a recipe's metadata - shortdoc, doc and flags - and its fully expanded, numbered step list, with the recipe each step came from and the include flags that gate it.

$ mix composer.recipe.show local:phx/app
Recipe local:phx/app (/home/you/.config/composer/recipes/phx.exs)

Standard Phoenix app

Builds on phx/clean and phx/defaults.

Flags:
  --gigalixir  Add Gigalixir deployment

Steps:
   1. core:phx/remove_theme_toggle  [local:phx/clean]
   2. core:setup/credo  [local:dev/env]
   3. core:cluster/gigalixir  [local:deploy/gigalixir] if :gigalixir
   4. composer_lab:auth/passkeys (as lab)  [local:phx/app]
   5. core:setup/sort_deps  [local:phx/finish]

Flags declared by recipes that this one :uses are listed after its own; mix composer.recipe.run accepts all of them.

A step written with a cookbook alias (see Composer.Recipe) shows the real cookbook name followed by the alias it was written with, (as lab). In --json, "aliases" holds the recipe's own aliases and each step's "alias" the one it was written with; "ref" and "label" always use the real name.

Every gated include is followed, so the list shows everything the recipe can run. Steps dropped as duplicates are listed after it, then warnings: a step whose phase comes before that of a step listed ahead of it, two steps that provide the same capability or conflict, and a step whose required step is not listed earlier.

Options

  • -c, --config - the local config directory (see Composer.Local)
  • --json - print JSON instead of text