shake

Search uses release 0.7.0.0 · 339 definitions

Releases (4)

0.7.0.0 indexed
0.6.0.0 unindexed
0.5.0.0 unindexed
0.4.0.0 unindexed

Definitions (339)

main.bend

def Clia program spec
def Suba nested command
def Argone argument: a flag, an option, a positional or a rest positional
def Matcheda successful parse, one command at a time: the bindings the command made, and the subcommand selected under it with its own Matched
def Varan env var's name and its value, a pair `(name, value)`: `parse_env` takes a list of them, and `env_vars` reads one for each env var that is set
def ParseErra failed parse
def SpecErrone way a spec contradicts itself
def appa program: name, about, optional version, top-level args and commands
def suba nested command
def flaga boolean flag
def opta valued option
def manyan option that may be given more than once; `get_all` reads every value, in order, and `get` the last
def posa positional
def resta rest positional: every leftover word, as one name
def envthis argument, falling back to the env var `var` when the words leave it unbound, before its default, as clap's `.env(var)`: `parse_env` reads it, and help shows `[env: VAR]`
def checkevery way a spec contradicts itself: a rest positional that is not the last, a repeated argument name or spelling, a repeated subcommand name, a subcommand named `help`, a default outside its choices, a required positional after an optional one.
def spec_err_texta report of `check` as one line
def Readone read a program makes of an argument, for `check_reads`
def ReadErrone read that does not fit the spec
def read_flaga read of the flag named `name` of the command `path` names, with `on`
def read_valuea read of the values of the argument named `name` of the command `path` names, with `get` or `get_all`
def check_readsevery read that does not fit the spec, in order: a path that names no command, a name no argument of that command has, a flag read of an argument that is not a flag, a value read of a flag.
def read_err_texta report of `check_reads` as one line
def parseargv against a program spec
def parse_envargv against a program spec, with `vars`, name and value pairs, for the env vars: an argument the words leave unbound falls back to its env var's value when it is set and not empty, then to its default
def getthe value this command bound to `name` last, or None when it bound none
def get_allevery value this command bound to `name`, in argv order
def onwhether this command's flag named `name` was set
def path_ofthe names of the subcommands selected below this command, in order: the whole selected path for the Matched `parse` answers
def sub_namethe name of the subcommand selected under this command, or None
def sub_ofthe Matched of subcommand `name` when it is the one selected, else None
def atthe Matched of the command `path` names below this one, following `sub_of` name by name, or None where a name is not the one selected
def helpthe usage page for `path` under `spec`; an unknown name in the path is skipped
def err_textthe message for a failed parse, ending with the root usage line; empty for a request for help, which the caller answers with `help`
def suggestionfor an unknown long option, the long option word of the current command it was likely meant to be, as `--name` for `--nmae`, which `err_text` shows as clap's tip; None for every other error and when nothing is close
def version_of`name version` when the parse failed with a request for the version (`--version`, `-V`) and the spec has a version, else None
def err_paththe command path where the parse failed: the path selected when it did, or for a request for help the path it asks about; the root for a request for the version
def help_paththe command path of a request for help (`help`, `help <path>`, `--help`, `-h`), or None when the parse failed for another reason
def env_varsthe env vars `spec` gives its arguments, each that is set with its value, for `parse_env`
def argvthe process's arguments, each word reusable, without the program name that `IO.args` starts with (bend 2.0.32 and later).

src/args.bend

def copya &1 list copied to &2
def wordsthe arguments of an IO.args line: every word after the program name, copied
def argvthe process's arguments, without the program name
def kepta name and its value in front of the pairs, when `IO.get_env` found one
def varsthe names that are set, each with its value, in order
def env_varsthe env vars a spec names that are set, each with its value

src/check.bend

type SpecErrone way a spec contradicts itself, at the command path where it does
def oneone report when the flag is set, else none
def bothtwo lists of reports, one after the other
def spelled.seenwhether a spelling, when there is one, is among those already seen
def spelled.addthe spellings seen, with this one when there is one
def args.defaulta default outside a nonempty choices list
def args.dupseach argument's name and spellings against the earlier ones', and its default against its choices
def pos.orderthe positionals in order: a rest before the last, and a required one after an optional one
def subs.dupseach subcommand's name against the earlier ones', and against `help`
def cmdone command's own reports
def pusheda name in front of a reversed path
def forestevery subcommand's reports, each under its own path, depth first.
def checkevery way the spec contradicts itself: the root's reports, then each subcommand's
def at.pickwhere a report is: the root, or a subcommand's path
def atwhere a report is
def texta report as one line
type Wanthow a program reads an argument: whether a flag is on (`on`), or its values (`get`, `get_all`)
type Readone read a program makes: the command path, the argument's name, and how it reads it
type ReadErrone read that does not fit the spec
def reads.onea read report when the flag is set, else none
def reads.argsthe arguments of a found command
def reads.downthe subcommand named `name` of a found command
def reads.cmdthe arguments of the command a path names below the command found, each name a subcommand of the command before it, or None
def reads.flagwhether an argument of this kind is a flag
def reads.wanta read of an argument that is, or is not, a flag
def reads.arga read of the argument found under its name, or of none
def reads.ata read of the command a path names, or of none
def readwhat is wrong with one read, or nothing
def check_readswhat is wrong with each read, in order
def read.atwhere a read report is
def read_texta read report as one line

src/cli.bend

type ArgKinda flag, a valued option, an option that may repeat, a positional, or a rest positional
type Fallbackwhat an argument the words leave unbound falls back to: the value of its env var, when `parse_env` is given one, else its default
type Argone argument: name is the binding key; short/long are the CLI spellings
type Suba nested command
type Clithe program: name, about, optional version, top-level args and commands
def Varan env var's name and its value, as `parse_env` is given them
type Bindone bound name and its text
type Levelone command above the current one: its arguments and the bindings made while it was current
type Matcheda successful parse, read one command at a time, as clap's ArgMatches: the bindings the command made, in binding order, and, when a subcommand was selected under it, that subcommand's name and Matched
type ParseErra failed parse.
type Modehow the next token is read
type Stthe walker: the current command's arguments, the commands above it (the nearest first, one per name of the selected path), its subcommands, the selected path, and the current command's own bindings
type Howthe page a help walk has reached
def appa program spec
def suba nested command
def flaga boolean flag
def opta valued option
def manyan option that may be given more than once; `get_all` reads every value
def posa positional
def resta rest positional: every leftover word, as one name
def envthis argument, falling back to the env var `var` (clap's `.env`)
def help.maxthe larger of two Nats
def help.spacesn spaces