glint

Types

CmdResult

pub type CmdResult(a) =
  Result(Out(a))

Command

</>

pub opaque type Command(a)

CommandInput

</>

pub type CommandInput {
  CommandInput(args: List(String), flags: FlagMap)
}

Constructors

CommandInput(args: List(String), flags: FlagMap)

</>

pub type Contents(a) {
  Contents(do: Runner(a), flags: FlagMap, desc: Description)
}

Constructors

Contents(do: Runner(a), flags: FlagMap, desc: Description)

Description

</>

pub type Description {
  Description(description: String, usage: String)
}

Constructors

Description(description: String, usage: String)

Out

</>

pub type Out(a) {
  Out(a)
  Help(String)
}

Constructors

```
Out(a)
```
```
Help(String)
```

Runner

</>

pub type Runner(a) =
  fn(CommandInput) -> a

Stub

</>

pub type Stub(a) {
  Stub(
    path: List(String),
    run: Runner(a),
    flags: List(Flag),
    description: String,
    usage: String,
  )
}

Constructors

Stub(
  path: List(String),
  run: Runner(a),
  flags: List(Flag),
  description: String,
  usage: String,
)

Functions

add_command

</>

pub fn add_command(to root: Command(a), at path: List(String), do f: fn(
    CommandInput,
  ) -> a, with flags: List(#(String, Contents)), described description: String, used usage: String) -> Command(
  a,
)

add_command_from_stub

</>

pub fn add_command_from_stub(to root: Command(a), with stub: Stub(
    a,
  )) -> Command(a)

execute

</>

pub fn execute(cmd: Command(a), args: List(String)) -> Result(
  Out(a),
  Snag,
)

help_flag

</>

pub fn help_flag() -> String

new

</>

pub fn new() -> Command(a)

run

</>

pub fn run(cmd: Command(a), args: List(String)) -> Nil