Definitively.Domain.ProgramInput (definitively v0.4.1)

Copy Markdown

Declarative CLI input for a workflow program.

Summary

Types

input_type()
t()

Functions

flag(name)

Returns the CLI flag for an input key (plan_file → --plan-file).

key_from_flag(arg1)

Parses a CLI flag into an input key (--plan-file → plan_file).

Types

input_type()

@type input_type() :: :path | :string

t()

@type t() :: %Definitively.Domain.ProgramInput{
  default: term() | nil,
  description: String.t() | nil,
  name: atom(),
  required: boolean(),
  type: input_type()
}

Functions

flag(name)

@spec flag(atom() | String.t()) :: String.t()

Returns the CLI flag for an input key (plan_file → --plan-file).

key_from_flag(arg1)

@spec key_from_flag(String.t()) :: {:ok, String.t()} | :error

Parses a CLI flag into an input key (--plan-file → plan_file).