clip/arg_info

Types

ArgInfo

pub type ArgInfo {
  ArgInfo(
    named: List(NamedInfo),
    positional: List(PositionalInfo),
    flags: List(FlagInfo),
    subcommands: List(String),
  )
}

Constructors

ArgInfo(
  named: List(NamedInfo),
  positional: List(PositionalInfo),
  flags: List(FlagInfo),
  subcommands: List(String),
)

FlagInfo

</>

pub type FlagInfo {
  FlagInfo(
    name: String,
    short: Option(String),
    help: Option(String),
  )
}

Constructors

FlagInfo(
  name: String,
  short: Option(String),
  help: Option(String),
)

NamedInfo

</>

pub type NamedInfo {
  NamedInfo(
    name: String,
    short: Option(String),
    default: Option(String),
    help: Option(String),
  )
}

Constructors

NamedInfo(
  name: String,
  short: Option(String),
  default: Option(String),
  help: Option(String),
)

PositionalInfo

</>

pub type PositionalInfo {
  PositionalInfo(
    name: String,
    default: Option(String),
    help: Option(String),
    repeat: Repeat,
  )
}

Constructors

PositionalInfo(
  name: String,
  default: Option(String),
  help: Option(String),
  repeat: Repeat,
)

Repeat

</>

pub type Repeat {
  NoRepeat
  ManyRepeat
  Many1Repeat
}

Constructors

```
NoRepeat
```
```
ManyRepeat
```
```
Many1Repeat
```

Functions

empty

</>

pub fn empty() -> ArgInfo

Create an empty ArgInfo value.

help_text

</>

pub fn help_text(
  info: ArgInfo,
  name: String,
  description: String,
) -> String

Generate user-facing help text from ArgInfo, a name, and a description.

merge

</>

pub fn merge(a: ArgInfo, b: ArgInfo) -> ArgInfo

Merge two ArgInfo values.