ridiculousfish / docopt_fish

docopt_fish

docopt_fish

Experimental implementation of docopt, targeted for fish.

docopt_fish (better name TBD) is a "toolkit" that supports command line argument parsing needs. Given a docopt usage specification, fish_docopt can:

1. Validate arguments (e.g. for syntax highlighting)
2. Suggest arguments (e.g. for tab completion)
3. Expose the commands, options, variables, descriptions, etc. to the client app
4. Parse a set of arguments (argv) against the spec, to extract values

Usage specifications are treated as user-supplied (not developer-supplied) data. This means that rich error messages are generated for invalid usage specs.

docopt_fish is written in C++11. It supports both std::string and std::wstring, and does not throw or catch exceptions.

docopt_fish is made available under the zlib license. See the LICENSE file.

Philosophical Differences from docopt

docopt is prescriptive, meaning that it attempts to define an argument-passing style. For example, all long options must use two dashes, and options that accept values may take them with a space or equals separator. "Legacy" styles are not supported.

docopt_fish is descriptive: it attempts to be sufficiently expressive as to describe the usage specifications of arbitrary commands. This means that it has to support all of the argument styles in common use.

Syntactic Differences from docopt

fish_docopt usage specification syntax has the following differences from docopt:

1. Variable names must be enclosed in brackets: <foo>, not FOO. Rationale: this avoids ambiguities for the case of abutting option-value names (think -DMACRO in gcc), and docopt plans the same change.

2. Section names are not required. For example, this:

      	   Usage: command argument [options]
      	   Options: -f, -fast
                    -i, --interactive
   

   May be rewritten as:

      	   command argument [options]
      	   -f, -fast
           -i, --interactive
   

   Lines are disambiguated according to their first character (excluding whitespace). Thus a - starts an Option Spec line, a < starts an Argument Spec line, and a non-punctuation character starts a Usage Spec line.

   However, unrecognized section names are considered to mark expository text, and their entire sections are ignored. This allows for a "Description:" section with expository text. The currently recognized section names are "Usage", "Synopsis", "Options", and "Arguments".

   Rationale: this makes the syntax more lightweight and suitable for personal or throwaway commands.

3. Single-dash long names are supported. Rationale: we need to express the full usage spec of external commands, and single-dash long names are common.

4. Variable names may not contain spaces. Rationale: most languages do not support spaces in variables names, and this may look like separate arguments in the usage spec.

5. docopt has relaxed separator semantics: --foo <var> may be written in argv as either --foo var or --foo=var. fish_docopt has strict semantics: argv must use the separator style specified in the usage spec. Rationale: most commands require one or the other style, and the usage spec must be able to express that.

6. Unambiguous-prefix abbreviation is not supported (e.g. --ver for --version). Rationale: most external commands do not support this, and docopt is likely to remove it.

7. Positional arguments after options are treated as values. For example: prog [-m <msg>] is assumed to be an option that takes a value <msg>. docopt instead treats this as a bare option, followed by a positional argument. Rationale: this seems more natural and more likely to be what the user expects.

8. Options are normalized to their "corresponding" long names. For example:

      	   Usage: prog [-v | --verbose]
   

   Passing -v here will result in the argument --verbose. Options are considered to correspond if they are on the same line in an Options: section, or if there are precisely one short and one non-short option in a square-brackets clause, and their argument value (if any) agrees.

9. Long usage specs may be broken across lines, by increasing the indent on subsequent lines. For example:

      	   Usage: prog [--some-long-option <some_value>]
      	               [--another-long-option <another_value>]
      		      prog --help
   

   Tabstops are currently fixed at 4. Rationale: Long usage specs are common in man pages.

10. Square brackets do apply to the contained sequence, not individual children. For example:

      	   Usage: prog [--option1 --option2]			   
    

    docopt interprets this as making --option1 and --option2 both independently optional. fish_docopt interprets this as requiring --option1 to be followed by --option2. Rationale: this is more consistent, and it is hard to find commands that depend on the docopt behavior. Independently optional commands should be specified with independent brackets.

11. 'Variable Commands' section. Lines beginning with a variable name like <foo> can be used to describe what values are allowed for variables. Example:

      	   cd <dir>
           <dir> echo */
    

    docopt_fish does not itself use the variable command, but does parse them and expose them to the app. Rationale: fish needs this.