clap/tests/app.yml

name: claptests
version: "1.0"
about: tests clap library
author: Kevin K. <kbknapp@gmail.com>
settings:
    - ArgRequiredElseHelp
help_message: prints help with a nonstandard description
args:
    - opt:
        short: o
        long: option
        multiple: true
        help: tests options
    - positional:
        help: tests positionals
        index: 1
    - positional2:
        help: tests positionals with exclusions
        index: 2
        default_value_if:
            - [flag, Null, some]
            - [postional, other, something]
    - flag:
        short: f
        long: flag
        multiple: true
        help: tests flags
        global: true
    - flag2:
        short: F
        help: tests flags with exclusions
        conflicts_with:
            - flag
        requires:
            - option2
    - option2:
        long: long-option-2
        help: tests long options with exclusions
        conflicts_with:
            - option
        requires:
            - positional2
    - option3:
        short: O
        long: Option
        help: tests options with specific value sets
        takes_value: true
        possible_values:
            - fast
            - slow
        requires_if:
            - [fast, flag]
    - positional3:
        index: 3
        help: tests positionals with specific values
        possible_values: [ vi, emacs ]
    - multvals:
        long: multvals
        help: Tests mutliple values, not mult occs
        value_names:
            - one
            - two
    - multvalsmo:
        long: multvalsmo
        multiple: true
        help: Tests mutliple values, not mult occs
        value_names: [one, two]
    - multvalsdelim:
        long: multvalsdelim
        help: Tests mutliple values with required delimiter
        multiple: true
        require_delimiter: true
    - singlealias:
        long: singlealias
        help: Tests single alias
        aliases: [alias]
        required_if:
            - [multvalsmo, two]
    - multaliases:
        long: multaliases
        help: Tests mutliple aliases
        aliases: [als1, als2, als3]
    - minvals2:
        long: minvals2
        multiple: true
        help: Tests 2 min vals
        min_values: 2
    - maxvals3:
        long: maxvals3
        multiple: true
        help: Tests 3 max vals
        max_values: 3
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
                help: tests options
                takes_value: true
            - scpositional:
                help: 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`
Support loading help_message and version_message from the YAML 2017-03-10 06:52:02 +00:00			`help_message: prints help with a nonstandard description`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`args:`
			`- opt:`
			`short: o`
			`long: option`
			`multiple: true`
			`help: tests options`
			`- positional:`
			`help: 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:`
			`help: 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:`
			`- [flag, Null, some]`
			`- [postional, other, something]`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- flag:`
			`short: f`
			`long: flag`
			`multiple: true`
			`help: tests flags`
			`global: true`
			`- flag2:`
			`short: F`
			`help: tests flags with exclusions`
			`conflicts_with:`
			`- flag`
			`requires:`
			`- option2`
			`- option2:`
			`long: long-option-2`
			`help: 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`
			`help: tests options with specific value sets`
			`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`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`help: tests positionals with specific values`
			`possible_values: [ vi, emacs ]`
			`- multvals:`
			`long: multvals`
			`help: Tests mutliple values, not mult occs`
			`value_names:`
			`- one`
			`- two`
			`- multvalsmo:`
			`long: multvalsmo`
			`multiple: true`
			`help: Tests mutliple values, not mult occs`
			`value_names: [one, two]`
imp(YAML): supports setting Arg::require_delimiter from YAML 2016-09-06 16:30:31 +00:00			`- multvalsdelim:`
			`long: multvalsdelim`
			`help: Tests mutliple values with required delimiter`
			`multiple: true`
			`require_delimiter: 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`
			`help: Tests single alias`
			`aliases: [alias]`
tests(YAML): adds some of the new APIs to the YAML tests 2016-12-29 04:18:07 +00:00			`required_if:`
			`- [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`
			`help: Tests mutliple aliases`
			`aliases: [als1, als2, als3]`
feat(YAML): allows building a CLI from YAML files 2015-08-31 03:26:17 +00:00			`- minvals2:`
			`long: minvals2`
			`multiple: true`
			`help: Tests 2 min vals`
			`min_values: 2`
			`- maxvals3:`
			`long: maxvals3`
			`multiple: true`
			`help: Tests 3 max vals`
			`max_values: 3`
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`
			`help: tests options`
			`takes_value: true`
			`- scpositional:`
			`help: tests positionals`
test(App from YAML): fixes yaml app declaration 2015-09-01 03:15:08 +00:00			`index: 1`