Command::allow_missing_positional

allow_missing_positional

since 0.1.0

Allows one to implement two styles of CLIs where positionals can be used out of order.

Examples

Example 1

Spec

TOML

name = "myprog"
allow-missing-positional = true
[args]
arg1 = {}
arg2 = { required = true }

YAML

name: myprog
allow-missing-positional: true
args:
  arg1: {}
  arg2:
    required: true

JSON

{
  "name": "myprog",
  "allow-missing-positional": true,
  "args": {
    "arg1": {},
    "arg2": {
      "required": true
    }
  }
}

Input

myprog other

Output

claptrap_arg2='other'

Example 2

Spec

TOML

name = "myprog"
allow-missing-positional = true
[args]
foo = {}
bar = {}
baz = { action = "set", num-args = "1.." }

YAML

name: myprog
allow-missing-positional: true
args:
  foo: {}
  bar: {}
  baz:
    action: set
    num-args: 1..

JSON

{
  "name": "myprog",
  "allow-missing-positional": true,
  "args": {
    "foo": {},
    "bar": {},
    "baz": {
      "action": "set",
      "num-args": "1.."
    }
  }
}

Input

myprog foo bar baz1 baz2 baz3

Output

claptrap_foo='foo'
claptrap_bar='bar'
claptrap_baz=('baz1' 'baz2' 'baz3')

Example 3

Spec

TOML

name = "myprog"
allow-missing-positional = true
[args]
foo = {}
bar = {}
baz = { action = "set", num-args = "1.." }

YAML

name: myprog
allow-missing-positional: true
args:
  foo: {}
  bar: {}
  baz:
    action: set
    num-args: 1..

JSON

{
  "name": "myprog",
  "allow-missing-positional": true,
  "args": {
    "foo": {},
    "bar": {},
    "baz": {
      "action": "set",
      "num-args": "1.."
    }
  }
}

Input

myprog -- baz1 baz2 baz3

Output

claptrap_baz=('baz1' 'baz2' 'baz3')

Example 4

Spec

TOML

name = "myprog"
allow-missing-positional = true
[args]
arg1 = { default-value = "something" }
arg2 = { required = true }

YAML

name: myprog
allow-missing-positional: true
args:
  arg1:
    default-value: something
  arg2:
    required: true

JSON

{
  "name": "myprog",
  "allow-missing-positional": true,
  "args": {
    "arg1": {
      "default-value": "something"
    },
    "arg2": {
      "required": true
    }
  }
}

Input

myprog other

Output

claptrap_arg2='other'
claptrap_arg1='something'