aboutsummaryrefslogtreecommitdiff
path: root/clap/examples/17_yaml.yml
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2020-01-07 11:18:04 +0000
committerDaniel Mueller <deso@posteo.net>2020-01-08 09:20:25 -0800
commit5e20a29b4fdc8a2d442d1093681b396dcb4b816b (patch)
tree55ab083fa8999d2ccbb5e921c1ffe52560dca152 /clap/examples/17_yaml.yml
parent203e691f46d591a2cc8acdfd850fa9f5b0fb8a98 (diff)
downloadnitrocli-5e20a29b4fdc8a2d442d1093681b396dcb4b816b.tar.gz
nitrocli-5e20a29b4fdc8a2d442d1093681b396dcb4b816b.tar.bz2
Add structopt dependency in version 0.3.7
This patch series replaces argparse with structopt in the argument handling code. As a first step, we need structopt as a dependency. Import subrepo structopt/:structopt at efbdda4753592e27bc430fb01f7b9650b2f3174d Import subrepo bitflags/:bitflags at 30668016aca6bd3b02c766e8347e0b4080d4c296 Import subrepo clap/:clap at 784524f7eb193e35f81082cc69454c8c21b948f7 Import subrepo heck/:heck at 093d56fbf001e1506e56dbfa38631d99b1066df1 Import subrepo proc-macro-error/:proc-macro-error at 6c4cfe79a622c5de8ae68557993542be46eacae2 Import subrepo proc-macro2/:proc-macro2 at d5d48eddca4566e5438e8a2cbed4a74e049544de Import subrepo quote/:quote at 727436c6c137b20f0f34dde5d8fda2679b9747ad Import subrepo rustversion/:rustversion at 0c5663313516263059ce9059ef81fc7a1cf655ca Import subrepo syn-mid/:syn-mid at 5d3d85414a9e6674e1857ec22a87b96e04a6851a Import subrepo syn/:syn at e87c27e87f6f4ef8919d0372bdb056d53ef0d8f3 Import subrepo textwrap/:textwrap at abcd618beae3f74841032aa5b53c1086b0a57ca2 Import subrepo unicode-segmentation/:unicode-segmentation at 637c9874c4fe0c205ff27787faf150a40295c6c3 Import subrepo unicode-width/:unicode-width at 3033826f8bf05e82724140a981d5941e48fce393 Import subrepo unicode-xid/:unicode-xid at 4baae9fffb156ba229665b972a9cd5991787ceb7
Diffstat (limited to 'clap/examples/17_yaml.yml')
-rw-r--r--clap/examples/17_yaml.yml97
1 files changed, 97 insertions, 0 deletions
diff --git a/clap/examples/17_yaml.yml b/clap/examples/17_yaml.yml
new file mode 100644
index 0000000..b0d58b3
--- /dev/null
+++ b/clap/examples/17_yaml.yml
@@ -0,0 +1,97 @@
+name: yml_app
+version: "1.0"
+about: an example using a .yml file to build a CLI
+author: Kevin K. <kbknapp@gmail.com>
+
+# AppSettings can be defined as a list and are **not** ascii case sensitive
+settings:
+ - ArgRequiredElseHelp
+
+# All Args must be defined in the 'args:' list where the name of the arg, is the
+# key to a Hash object
+args:
+ # The name of this argument, is 'opt' which will be used to access the value
+ # later in your Rust code
+ - opt:
+ help: example option argument from yaml
+ short: o
+ long: option
+ multiple: true
+ takes_value: true
+ - pos:
+ help: example positional argument from yaml
+ index: 1
+ # A list of possible values can be defined as a list
+ possible_values:
+ - fast
+ - slow
+ - flag:
+ help: demo flag argument
+ short: F
+ multiple: true
+ global: true
+ # Conflicts, mutual overrides, and requirements can all be defined as a
+ # list, where the key is the name of the other argument
+ conflicts_with:
+ - opt
+ requires:
+ - pos
+ - mode:
+ long: mode
+ help: shows an option with specific values
+ # possible_values can also be defined in this list format
+ possible_values: [ vi, emacs ]
+ takes_value: true
+ - mvals:
+ long: mult-vals
+ help: demos an option which has two named values
+ # value names can be described in a list, where the help will be shown
+ # --mult-vals <one> <two>
+ value_names:
+ - one
+ - two
+ - minvals:
+ long: min-vals
+ multiple: true
+ help: you must supply at least two values to satisfy me
+ min_values: 2
+ - maxvals:
+ long: max-vals
+ multiple: true
+ help: you can only supply a max of 3 values for me!
+ max_values: 3
+
+# All subcommands must be listed in the 'subcommand:' object, where the key to
+# the list is the name of the subcommand, and all settings for that command are
+# are part of a Hash object
+subcommands:
+ # The name of this subcommand will be 'subcmd' which can be accessed in your
+ # Rust code later
+ - subcmd:
+ about: demos subcommands from yaml
+ version: "0.1"
+ author: Kevin K. <kbknapp@gmail.com>
+ # Subcommand args are exactly like App args
+ args:
+ - scopt:
+ short: B
+ multiple: true
+ help: example subcommand option
+ takes_value: true
+ - scpos1:
+ help: example subcommand positional
+ index: 1
+
+# ArgGroups are supported as well, and must be sepcified in the 'groups:'
+# object of this file
+groups:
+ # the name of the ArgGoup is specified here
+ - min-max-vals:
+ # All args and groups that are a part of this group are set here
+ args:
+ - minvals
+ - maxvals
+ # setting conflicts is done the same manner as setting 'args:'
+ #
+ # to make this group required, you could set 'required: true' but for
+ # this example we won't do that.