Expublish.Options (expublish v2.4.2) View Source

Validate and parse mix task arguments.

Link to this section Summary

Types

t()

Options

Functions

Default options used for every run.

Parse mix task arguments and merge with default options.

Print help to stdout.

Validates options and level combinations.

Link to this section Types

Specs

level() :: :major | :minor | :patch | :alpha | :beta | :rc | :stable

Specs

t() :: %Expublish.Options{
  allow_untracked: term(),
  as_major: term(),
  as_minor: term(),
  branch: term(),
  commit_prefix: term(),
  disable_publish: term(),
  disable_push: term(),
  disable_test: term(),
  dry_run: term(),
  help: term(),
  remote: term(),
  tag_prefix: term()
}

Options

Link to this section Functions

Specs

defaults() :: struct()

Default options used for every run.

Returns following map:

%Expublish.Options{
  allow_untracked: false,
  as_major: false,
  as_minor: false,
  branch: "master",
  commit_prefix: "Version release",
  disable_publish: false,
  disable_push: false,
  disable_test: false,
  dry_run: false,
  help: false,
  remote: "origin",
  tag_prefix: "v"
}

Specs

parse([String.t()]) :: struct()

Parse mix task arguments and merge with default options.

Link to this function

typed_options_from_default()

View Source
Link to this function

validate(options, level)

View Source

Specs

validate(t(), level()) :: :ok | String.t()

Validates options and level combinations.

Returns :ok or error message.