dev_tools/internals/cli

The cli module is how we create “scripts” that are intended to be run from the command line.

Types

Cli

opaque </>

pub opaque type Cli(a)

Functions

do

</>

pub fn do(step: Cli(a), then next: fn(a) -> Cli(b)) -> Cli(b)

from_result

</>

pub fn from_result(result: Result(a, Error)) -> Cli(a)

get_bool

</>

pub fn get_bool(
  name: String,
  fallback: Bool,
  namespace: List(String),
  flag: fn(Flags) -> Result(Bool, a),
) -> Cli(Bool)

get_config

</>

pub fn get_config() -> Cli(Config)

get_config_value

</>

pub fn get_config_value(
  name: String,
  fallback: a,
  namespace: List(String),
  toml: fn(Dict(String, Toml), List(String)) -> Result(a, b),
  flag: fn(Flags) -> Result(a, c),
) -> Cli(a)

get_flags

</>

pub fn get_flags() -> Cli(Flags)

get_int

</>

pub fn get_int(
  name: String,
  fallback: Int,
  namespace: List(String),
  flag: fn(Flags) -> Result(Int, a),
) -> Cli(Int)

get_name

</>

pub fn get_name() -> Cli(String)

get_string

</>

pub fn get_string(
  name: String,
  fallback: String,
  namespace: List(String),
  flag: fn(Flags) -> Result(String, a),
) -> Cli(String)

in

</>

pub fn in(value: fn() -> a) -> Cli(a)

log

</>

pub fn log(message: String, then next: fn() -> Cli(a)) -> Cli(a)

map

</>

pub fn map(step: Cli(a), then next: fn(a) -> b) -> Cli(b)

mute

</>

pub fn mute() -> Cli(Nil)

notify

</>

pub fn notify(
  message: String,
  then next: fn() -> Cli(a),
) -> Cli(a)

return

</>

pub fn return(value: a) -> Cli(a)

run

</>

pub fn run(step: Cli(a), flags: Flags) -> Result(a, Error)

success

</>

pub fn success(
  message: String,
  then next: fn() -> Cli(a),
) -> Cli(a)

template

</>

pub fn template(
  name: String,
  then next: fn(String) -> Cli(a),
) -> Cli(a)

throw

</>

pub fn throw(error: Error) -> Cli(a)

try

</>

pub fn try(
  result: Result(a, Error),
  then next: fn(a) -> Cli(b),
) -> Cli(b)

unmute

</>

pub fn unmute() -> Cli(Nil)