~curious/docopticon

Help-text-based argument parsing
1fe2dd42 — CuriouslyCurious 11 months ago
Re-add Cargo.lock to project
18c2a280 — CuriouslyCurious 11 months ago
Remove unused dep
12170863 — CuriouslyCurious 11 months ago
Add a bunch more serde-libraries and features

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~curious/docopticon
read/write
git@git.sr.ht:~curious/docopticon

You can also use your local clone with git send-email.

#docopticon

docopticon is yet-another argument parsing library for Rust, however, this one relies upon constructing the argument tree from the actual help text that every command-line program should have. This is instead of generating the help for every argument.

#Example

use docopticon;
???
profit

#TODO

Stuff I need to write:

#Parsers

  • usage-option
  • usage-parameter
  • usage-optional-parameters () {} []
  • default-in-description () {} []
  • stdin - and parameter flag --
  • slices / ranges of values a..b
  • multiple choice parameters

#Argument Tree

  • option levels
  • associated function?

#Features

  • Compile-time generation of an argument tree from a given Usage string slice.
  • no_std - only depends on libc and Rust's core library.
  • Does not require an allocator - could potentially work on embedded targets.
  • Also includes a set of functions to allow for XDG-dirs compliant saving/loading of configuration, state and data files.

#Docopt

docopt is a standard that is vaguely defined by the docopt team behind the initial Python library. This library attempts to be more rigorous in the definition of the core protocol but still allowing for some flexibility when it comes to how you write your Usage: text.

#Credits