HostKit.CommandLine (host_kit v0.1.0-beta.6)

A parsed or built simple command line stored as argv.

Summary

option_style()

t()

Builds a command line from a command, positional args, and structured CLI options.

Builds an Elixir command line.

Builds an elixir -e command line.

Builds a Mix task command line.

parse(source)

parse!(source)

to_exec(command)

Normalizes a HostKit command shape into {command, args} argv form.

@type option_style() :: :gnu | :equals | :single_dash | :short | :underscore

@type t() :: %HostKit.CommandLine{
  args: [String.t()],
  ast: term(),
  command: String.t(),
  source: String.t() | nil
}

@spec argv(
  String.t(),
  keyword()
) :: t()

Builds a command line from a command, positional args, and structured CLI options.

Builds an Elixir command line.

@spec elixir(
  keyword() | String.t() | [String.t()],
  keyword()
) :: t()

@spec eval(
  String.t(),
  keyword()
) :: t()

Builds an elixir -e command line.

@spec mix(
  String.t() | atom(),
  keyword()
) :: t()

Builds a Mix task command line.

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

@spec parse!(String.t()) :: t()

@spec to_exec(t() | String.t() | {term(), [term()]} | [term()]) ::
  {String.t(), [String.t()]}

Normalizes a HostKit command shape into {command, args} argv form.