sheen/command

Types

ArgSpec

pub type ArgSpec {
  ArgSpec(
    display: option.Option(String),
    repeated: Bool,
    optional: Bool,
    help: String,
  )
}

Constructors

ArgSpec(
  display: option.Option(String),
  repeated: Bool,
  optional: Bool,
  help: String,
)

BuildError

</>

pub type BuildError =
  String

BuildResult

</>

pub type BuildResult(a) =
  Result(Builder(a), BuildError)

Builder

</>

pub type Builder(a) {
  Builder(spec: CommandSpec, validator: Validator(a))
}

Constructors

Builder(spec: CommandSpec, validator: Validator(a))

BuilderFn

</>

pub type BuilderFn(a) =
  fn(CommandSpec) -> BuildResult(a)

Command

</>

pub type Command(a, b) =
  fn(Continuation(a, b)) -> BuilderFn(b)

CommandSpec

</>

pub type CommandSpec {
  CommandSpec(
    flags: dict.Dict(String, FlagSpec),
    named: dict.Dict(String, NamedSpec),
    args: List(ArgSpec),
    subcommands: dict.Dict(String, CommandSpec),
    description: option.Option(String),
  )
}

Constructors

CommandSpec(
  flags: dict.Dict(String, FlagSpec),
  named: dict.Dict(String, NamedSpec),
  args: List(ArgSpec),
  subcommands: dict.Dict(String, CommandSpec),
  description: option.Option(String),
)

Continuation

</>

pub type Continuation(a, b) =
  fn(Validator(a)) -> BuilderFn(b)

FlagSpec

</>

pub type FlagSpec {
  FlagSpec(
    short: option.Option(String),
    long: option.Option(String),
    display: option.Option(String),
    count: Bool,
    help: String,
  )
}

Constructors

FlagSpec(
  short: option.Option(String),
  long: option.Option(String),
  display: option.Option(String),
  count: Bool,
  help: String,
)

NamedSpec

</>

pub type NamedSpec {
  NamedSpec(
    short: option.Option(String),
    long: option.Option(String),
    display: option.Option(String),
    repeated: Bool,
    optional: Bool,
    help: String,
  )
}

Constructors

NamedSpec(
  short: option.Option(String),
  long: option.Option(String),
  display: option.Option(String),
  repeated: Bool,
  optional: Bool,
  help: String,
)

ValidationError

</>

pub type ValidationError =
  String

ValidationResult

</>

pub type ValidationResult(a) =
  Result(a, ValidationError)

Validator

</>

pub type Validator(a) =
  fn(ValidatorInput) -> ValidationResult(a)

ValidatorInput

</>

pub type ValidatorInput {
  ValidatorInput(
    flags: dict.Dict(String, Int),
    named: dict.Dict(String, List(String)),
    args: List(String),
    subcommands: dict.Dict(String, ValidatorInput),
  )
}

Constructors

ValidatorInput(
  flags: dict.Dict(String, Int),
  named: dict.Dict(String, List(String)),
  args: List(String),
  subcommands: dict.Dict(String, ValidatorInput),
)

Functions

command

</>

pub fn command(
  builder: fn(CommandSpec) -> Result(Builder(a), String),
) -> fn(
  fn(fn(ValidatorInput) -> Result(a, String)) ->
    fn(CommandSpec) -> Result(Builder(b), String),
) -> fn(CommandSpec) -> Result(Builder(b), String)

describe

</>

pub fn describe(
  description: String,
  cont: fn(CommandSpec) -> Result(Builder(a), String),
) -> fn(CommandSpec) -> Result(Builder(a), String)

new

</>

pub fn new() -> CommandSpec

return

</>

pub fn return(
  validator: fn(ValidatorInput) -> Result(a, String),
) -> fn(CommandSpec) -> Result(Builder(a), String)