clap/tests/fixtures/app.yaml

name: claptests
version: "1.0"
about: tests clap library
author: Kevin K. <kbknapp@gmail.com>
settings:
    - ArgRequiredElseHelp
ignored_field: This field is ignored
args:
    - help:
        short: h
        long: help
        about: prints help with a nonstandard description
        ignored_field: This field is ignored
    - option:
        short: o
        long: option
        takes_value: true
        multiple: true
        about: tests options
    - positional:
        about: tests positionals
        index: 1
    - positional2:
        about: tests positionals with exclusions
        index: 2
        default_value_if:
            - [flag, null, some]
            - [positional, other, something]
    - flag:
        short: f
        long: flag
        takes_value: true
        multiple: true
        about: tests flags
        global: true
    - flag2:
        short: F
        about: tests flags with exclusions
        conflicts_with:
            - flag
        requires:
            - option2
    - option2:
        long: long-option-2
        about: tests long options with exclusions
        conflicts_with:
            - option
        requires:
            - positional2
    - option3:
        short: O
        long: Option
        about: tests options with specific value sets
        takes_value: true
        possible_values:
            - fast
            - slow
        requires_if:
            - [fast, flag]
    - positional3:
        index: 3
        about: tests positionals with specific values
        possible_values: [ vi, emacs ]
    - multvals:
        long: multvals
        about: Tests multiple values, not mult occs
        value_names:
            - one
            - two
    - multvalsmo:
        long: multvalsmo
        multiple: true
        about: Tests multiple values, not mult occs
        value_names: [one, two]
    - multvalsdelim:
        long: multvalsdelim
        about: Tests multiple values with required delimiter
        takes_value: true
        multiple: true
        use_delimiter: true
        require_delimiter: true
    - settings:
        short: s
        takes_value: true
        multiple_values: true
    - singlealias:
        long: singlealias
        about: Tests single alias
        aliases: [alias]
        required_if_eq:
            - [multvalsmo, two]
    - multaliases:
        long: multaliases
        about: Tests multiple aliases
        aliases: [als1, als2, als3]
    - singleshortalias:
        long: singleshortalias
        about: Tests single short alias
        short_aliases: [a]
        required_if_eq:
            - [multvalsmo, two]
    - multshortaliases:
        long: multshortaliases
        about: Tests multiple short aliases
        short_aliases: [b, c]
    - minvals2:
        long: minvals2
        multiple: true
        about: Tests 2 min vals
        min_values: 2
    - maxvals3:
        long: maxvals3
        multiple: true
        about: Tests 3 max vals
        max_values: 3
    - exclusive:
        long: exclusive
        about: Tests 3 exclusive
        exclusive: true
    - case_insensitive:
        index: 4
        help: Test case_insensitive
        possible_values: [test123, test321]
        case_insensitive: true
    - value_hint:
        long: value-hint
        help: Test value_hint
        value_hint: FilePath
    - verbose:
        short: v
        multiple_occurrences: true
        takes_value: false
        help: Sets the level of verbosity
    - visiblealiases:
        long: visiblealiases
        about: Tests visible aliases
        visible_alias: visals1
        visible_aliases: [visals2, visals2, visals3]
    - visibleshortaliases:
        long: visibleshortaliases
        about: Tests visible short aliases
        visible_short_alias: e
        visible_short_aliases: [l, m]

arg_groups:
    - test:
        args:
            - maxvals3
            - minmals2
        conflicts_with:
            - option3
        requires:
            - multvals
subcommands:
    - subcmd:
        about: tests subcommands
        version: "0.1"
        author: Kevin K. <kbknapp@gmail.com>
        args:
            - scoption:
                short: o
                long: option
                multiple: true
                about: tests options
                takes_value: true
            - scpositional:
                about: tests positionals
                index: 1
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`name: claptests`
Issues rollup (#637) * feat: adds App::with_defaults to automatically use crate_authors! and crate_version! macros One can now use ```rust let a = App::with_defaults("My Program"); // same as let a2 = App::new("My Program") .version(crate_version!()) .author(crate_authors!()); ``` Closes #600 * imp(YAML Errors): vastly improves error messages when using YAML When errors are made while developing, the panic error messages have been improved instead of relying on the default panic message which is extremely unhelpful. Closes #574 * imp(Completions): uses standard conventions for bash completion files, namely '{bin}.bash-completion' Closes #567 * imp(Help): automatically moves help text to the next line and wraps when term width is determined to be too small, or help text is too long Now `clap` will check if it should automatically place long help messages on the next line after the flag/option. This is determined by checking to see if the space taken by flag/option plus spaces and values doesn't leave enough room for the entirety of the help message, with the single exception of of if the flag/option/spaces/values is less than 25% of the width. Closes #597 * tests: updates help tests to new forced new line rules * fix(Groups): fixes some usage strings that contain both args in groups and ones that conflict with each other Args that conflict and are in a group will now only display in the group and not in the usage string itself. Closes #616 * chore: updates dep graph Closes #633 * chore: clippy run * style: changes debug header to match other Rust projects * chore: increase version 2016-08-28 03:42:31 +00:00			`version: "1.0"`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`about: tests clap library`
			`author: Kevin K. <kbknapp@gmail.com>`
style: removes trailing whitespace 2015-10-01 01:45:35 +00:00			`settings:`
docs(YAML): adds examples for using YAML to build a CLI 2015-09-01 03:50:17 +00:00			`- ArgRequiredElseHelp`
Ignore extra fields in Arg yaml definitions 2021-03-14 01:11:50 +00:00			`ignored_field: This field is ignored`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`args:`
Fix compiling with "--features yaml" 2019-06-19 22:49:09 +00:00			`- help:`
			`short: h`
			`long: help`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: prints help with a nonstandard description`
Ignore extra fields in Arg yaml definitions 2021-03-14 01:11:50 +00:00			`ignored_field: This field is ignored`
Fix some issues 2020-04-09 16:19:05 +00:00			`- option:`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`short: o`
			`long: option`
Demangle interlinking flags 2021-02-24 15:07:57 +00:00			`takes_value: true`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`multiple: true`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests options`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- positional:`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests positionals`
test(App from YAML): fixes yaml app declaration 2015-09-01 03:15:08 +00:00			`index: 1`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- positional2:`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests positionals with exclusions`
test(App from YAML): fixes yaml app declaration 2015-09-01 03:15:08 +00:00			`index: 2`
tests(YAML): adds some of the new APIs to the YAML tests 2016-12-29 04:18:07 +00:00			`default_value_if:`
Fix YAML null value in fixture The YAML null value is called `null` in YAML, not `Null`. yaml-rust handles those values according to spec, so we should use the correct capitalization. See https://yaml.org/spec/1.2/spec.html#id2803362 for more information. 2020-08-14 15:46:51 +00:00			`- [flag, null, some]`
Fix various typos in docs & code Most errors detected and fixed with Topy (https://github.com/intgr/topy), all verified by hand. 2020-07-18 17:47:04 +00:00			`- [positional, other, something]`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- flag:`
			`short: f`
			`long: flag`
Demangle interlinking flags 2021-02-24 15:07:57 +00:00			`takes_value: true`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`multiple: true`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests flags`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`global: true`
			`- flag2:`
			`short: F`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests flags with exclusions`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`conflicts_with:`
			`- flag`
			`requires:`
			`- option2`
			`- option2:`
			`long: long-option-2`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests long options with exclusions`
style: removes trailing whitespace 2015-10-01 01:45:35 +00:00			`conflicts_with:`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- option`
style: removes trailing whitespace 2015-10-01 01:45:35 +00:00			`requires:`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- positional2`
			`- option3:`
			`short: O`
			`long: Option`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests options with specific value sets`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`takes_value: true`
			`possible_values:`
			`- fast`
			`- slow`
tests(YAML): adds some of the new APIs to the YAML tests 2016-12-29 04:18:07 +00:00			`requires_if:`
			`- [fast, flag]`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- positional3:`
test(App from YAML): fixes yaml app declaration 2015-09-01 03:15:08 +00:00			`index: 3`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests positionals with specific values`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`possible_values: [ vi, emacs ]`
			`- multvals:`
			`long: multvals`
Fix various typos in docs & code Most errors detected and fixed with Topy (https://github.com/intgr/topy), all verified by hand. 2020-07-18 17:47:04 +00:00			`about: Tests multiple values, not mult occs`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`value_names:`
			`- one`
			`- two`
			`- multvalsmo:`
			`long: multvalsmo`
			`multiple: true`
Fix various typos in docs & code Most errors detected and fixed with Topy (https://github.com/intgr/topy), all verified by hand. 2020-07-18 17:47:04 +00:00			`about: Tests multiple values, not mult occs`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`value_names: [one, two]`
imp(YAML): supports setting Arg::require_delimiter from YAML 2016-09-06 16:30:31 +00:00			`- multvalsdelim:`
			`long: multvalsdelim`
Fix various typos in docs & code Most errors detected and fixed with Topy (https://github.com/intgr/topy), all verified by hand. 2020-07-18 17:47:04 +00:00			`about: Tests multiple values with required delimiter`
Demangle interlinking flags 2021-02-24 15:07:57 +00:00			`takes_value: true`
imp(YAML): supports setting Arg::require_delimiter from YAML 2016-09-06 16:30:31 +00:00			`multiple: true`
Demangle interlinking flags 2021-02-24 15:07:57 +00:00			`use_delimiter: true`
imp(YAML): supports setting Arg::require_delimiter from YAML 2016-09-06 16:30:31 +00:00			`require_delimiter: true`
Add yaml multiple_* tests 2021-05-07 06:32:34 +00:00			`- settings:`
			`short: s`
			`takes_value: true`
			`multiple_values: true`
feat(arg_aliases): Ability to alias arguments There are some cases where you need to have an argument to have an alias, an example could be when you depricate one option in favor of another one. Now you are going to be able to alias arguments as follows: ``` Arg::with_name("opt") .long("opt") .short("o") .takes_value(true) .alias("invisible") .visible_alias("visible") ``` Closes #669 2016-09-30 21:54:14 +00:00			`- singlealias:`
			`long: singlealias`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: Tests single alias`
feat(arg_aliases): Ability to alias arguments There are some cases where you need to have an argument to have an alias, an example could be when you depricate one option in favor of another one. Now you are going to be able to alias arguments as follows: ``` Arg::with_name("opt") .long("opt") .short("o") .takes_value(true) .alias("invisible") .visible_alias("visible") ``` Closes #669 2016-09-30 21:54:14 +00:00			`aliases: [alias]`
Arg::required_if => required_if_eq 2020-05-23 14:02:03 +00:00			`required_if_eq:`
tests(YAML): adds some of the new APIs to the YAML tests 2016-12-29 04:18:07 +00:00			`- [multvalsmo, two]`
feat(arg_aliases): Ability to alias arguments There are some cases where you need to have an argument to have an alias, an example could be when you depricate one option in favor of another one. Now you are going to be able to alias arguments as follows: ``` Arg::with_name("opt") .long("opt") .short("o") .takes_value(true) .alias("invisible") .visible_alias("visible") ``` Closes #669 2016-09-30 21:54:14 +00:00			`- multaliases:`
			`long: multaliases`
Fix various typos in docs & code Most errors detected and fixed with Topy (https://github.com/intgr/topy), all verified by hand. 2020-07-18 17:47:04 +00:00			`about: Tests multiple aliases`
feat(arg_aliases): Ability to alias arguments There are some cases where you need to have an argument to have an alias, an example could be when you depricate one option in favor of another one. Now you are going to be able to alias arguments as follows: ``` Arg::with_name("opt") .long("opt") .short("o") .takes_value(true) .alias("invisible") .visible_alias("visible") ``` Closes #669 2016-09-30 21:54:14 +00:00			`aliases: [als1, als2, als3]`
allow short aliases on Arg this implements Arg::short_alias, Arg::short_aliases, Arg::short_visible_alias, and Arg::short_visible_aliases in addition to adding their associated tests 2020-05-03 06:13:24 +00:00			`- singleshortalias:`
			`long: singleshortalias`
			`about: Tests single short alias`
			`short_aliases: [a]`
Arg::required_if => required_if_eq 2020-05-23 14:02:03 +00:00			`required_if_eq:`
allow short aliases on Arg this implements Arg::short_alias, Arg::short_aliases, Arg::short_visible_alias, and Arg::short_visible_aliases in addition to adding their associated tests 2020-05-03 06:13:24 +00:00			`- [multvalsmo, two]`
			`- multshortaliases:`
			`long: multshortaliases`
Fix various typos in docs & code Most errors detected and fixed with Topy (https://github.com/intgr/topy), all verified by hand. 2020-07-18 17:47:04 +00:00			`about: Tests multiple short aliases`
Fix buggy tests 2020-08-02 16:52:12 +00:00			`short_aliases: [b, c]`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- minvals2:`
			`long: minvals2`
			`multiple: true`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: Tests 2 min vals`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`min_values: 2`
			`- maxvals3:`
			`long: maxvals3`
			`multiple: true`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: Tests 3 max vals`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`max_values: 3`
feat: Add `Arg::conflicts_with_everything` method #1583 (#1624) * feat: Add `Arg::conflicts_with_everything` method #1583 * fix: Typo in src/build/arg/mod.rs Co-Authored-By: Dylan DPC <dylan.dpc@gmail.com> Co-authored-by: Dylan DPC <dylan.dpc@gmail.com> 2020-01-05 18:46:28 +00:00			`- exclusive:`
			`long: exclusive`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: Tests 3 exclusive`
feat: Add `Arg::conflicts_with_everything` method #1583 (#1624) * feat: Add `Arg::conflicts_with_everything` method #1583 * fix: Typo in src/build/arg/mod.rs Co-Authored-By: Dylan DPC <dylan.dpc@gmail.com> Co-authored-by: Dylan DPC <dylan.dpc@gmail.com> 2020-01-05 18:46:28 +00:00			`exclusive: true`
adding case_insensitive to yaml parsing 2018-11-05 03:46:32 +00:00			`- case_insensitive:`
Fix some stuff 2020-05-12 08:39:24 +00:00			`index: 4`
adding case_insensitive to yaml parsing 2018-11-05 03:46:32 +00:00			`help: Test case_insensitive`
			`possible_values: [test123, test321]`
			`case_insensitive: true`
Add hinting of arg value types for zsh/fish completion Adds new method/attribute `Arg::value_hint`, taking a `ValueHint` enum as argument. The hint can denote accepted values, for example: paths, usernames, hostnames, commands, etc. This initial implementation supports hints for the zsh and fish completion generators, support for other shells can be added later. 2020-04-07 23:34:53 +00:00			`- value_hint:`
			`long: value-hint`
			`help: Test value_hint`
			`value_hint: FilePath`
Add yaml multiple_* tests 2021-05-07 06:32:34 +00:00			`- verbose:`
			`short: v`
			`multiple_occurrences: true`
			`takes_value: false`
			`help: Sets the level of verbosity`
fix: allow visible alias(es) in yaml files 2021-01-19 20:47:17 +00:00			`- visiblealiases:`
			`long: visiblealiases`
			`about: Tests visible aliases`
			`visible_alias: visals1`
			`visible_aliases: [visals2, visals2, visals3]`
			`- visibleshortaliases:`
			`long: visibleshortaliases`
			`about: Tests visible short aliases`
			`visible_short_alias: e`
			`visible_short_aliases: [l, m]`
adding case_insensitive to yaml parsing 2018-11-05 03:46:32 +00:00
tests: fixed yaml test 2015-09-06 20:34:15 +00:00			`arg_groups:`
tests: adds test for ArgGroups 2015-09-04 17:58:00 +00:00			`- test:`
style: removes trailing whitespace 2015-10-01 01:45:35 +00:00			`args:`
tests: adds test for ArgGroups 2015-09-04 17:58:00 +00:00			`- maxvals3`
			`- minmals2`
			`conflicts_with:`
			`- option3`
			`requires:`
			`- multvals`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`subcommands:`
			`- subcmd:`
			`about: tests subcommands`
Issues rollup (#637) * feat: adds App::with_defaults to automatically use crate_authors! and crate_version! macros One can now use ```rust let a = App::with_defaults("My Program"); // same as let a2 = App::new("My Program") .version(crate_version!()) .author(crate_authors!()); ``` Closes #600 * imp(YAML Errors): vastly improves error messages when using YAML When errors are made while developing, the panic error messages have been improved instead of relying on the default panic message which is extremely unhelpful. Closes #574 * imp(Completions): uses standard conventions for bash completion files, namely '{bin}.bash-completion' Closes #567 * imp(Help): automatically moves help text to the next line and wraps when term width is determined to be too small, or help text is too long Now `clap` will check if it should automatically place long help messages on the next line after the flag/option. This is determined by checking to see if the space taken by flag/option plus spaces and values doesn't leave enough room for the entirety of the help message, with the single exception of of if the flag/option/spaces/values is less than 25% of the width. Closes #597 * tests: updates help tests to new forced new line rules * fix(Groups): fixes some usage strings that contain both args in groups and ones that conflict with each other Args that conflict and are in a group will now only display in the group and not in the usage string itself. Closes #616 * chore: updates dep graph Closes #633 * chore: clippy run * style: changes debug header to match other Rust projects * chore: increase version 2016-08-28 03:42:31 +00:00			`version: "0.1"`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`author: Kevin K. <kbknapp@gmail.com>`
			`args:`
			`- scoption:`
			`short: o`
			`long: option`
			`multiple: true`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests options`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`takes_value: true`
			`- scpositional:`
Fix yaml tests 2020-04-27 14:49:26 +00:00			`about: tests positionals`
test(App from YAML): fixes yaml app declaration 2015-09-01 03:15:08 +00:00			`index: 1`