Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding FromArgs::help_json_from_args() to get JSON encoded help message #115

Open
wants to merge 14 commits into
base: master
Choose a base branch
from

Commits on Dec 13, 2021

  1. Adding --help-json to get JSON encoded help message (#1)

    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    
    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    claywilkinson authored Dec 13, 2021
    Configuration menu
    Copy the full SHA
    4b21242 View commit details
    Browse the repository at this point in the history

Commits on Dec 14, 2021

  1. Adding --help-json to get JSON encoded help message (#2)

    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    
    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    
    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    claywilkinson authored Dec 14, 2021
    Configuration menu
    Copy the full SHA
    56f4a21 View commit details
    Browse the repository at this point in the history
  2. Adding --help-json to get JSON encoded help message

    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    claywilkinson committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    287703b View commit details
    Browse the repository at this point in the history

Commits on Dec 29, 2021

  1. Adding --help-json to get JSON encoded help message (#1)

    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    
    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    claywilkinson committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    767fc8d View commit details
    Browse the repository at this point in the history
  2. Adding --help-json to get JSON encoded help message (#2)

    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    
    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    
    * Adding --help-json to get JSON encoded help message
    
    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    claywilkinson committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    34a647b View commit details
    Browse the repository at this point in the history
  3. Adding --help-json to get JSON encoded help message

    This adds the `--help-json` flag which prints the help information
    encoded in a JSON object. This enables template engines to render
    the help information in other formats such as markdown.
    claywilkinson committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    66e80be View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    b7d61a3 View commit details
    Browse the repository at this point in the history
  5. Adding argh::help_json_from_args()

    This adds 2 methods to arghm, help_json_from_args() and
    help_json(), which is parallel to ::from_env().
    
    The return value is a JSON encoded string suitable for
    parsing and using as input to generate reference docs.
    claywilkinson committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    8131de1 View commit details
    Browse the repository at this point in the history
  6. Adding argh::help_json_from_args()

    This adds 2 methods to arghm, help_json_from_args() and
    help_json(), which is parallel to ::from_env().
    
    The return value is a JSON encoded string suitable for
    parsing and using as input to generate reference docs.
    claywilkinson committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    f00f762 View commit details
    Browse the repository at this point in the history
  7. reverting unnessary changes.

    These were made inadvertently when merging changes.
    claywilkinson committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    03f0229 View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    cca7412 View commit details
    Browse the repository at this point in the history
  9. Consolidating help JSON schema and usage.

    This makes several changes that make it easier to use the JSON
    help data and also makes it more complete.
    
    * The subcommands are recursively called to collect the help information
      for each command. This means one call to help_json_from_args on the
      "TopLevel" struct will generate complete help for all subcommands.
    * `options` has been renamed to `flags`.
    * optionality has been added to the flags. This is "required",
      "optional", "repeated", or a Rust fragment containing for the default
      value.
    * "arg_name" as been added to flags.
    claywilkinson committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    a2bd1b5 View commit details
    Browse the repository at this point in the history

Commits on Dec 30, 2021

  1. Adding README documentation and clippy warnings

    This also adds a default implementation of help_json_from_args for
    FromArgs in order to be backwards compatible with non `derived`
    implmentations of the FromArgs trait.
    claywilkinson committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    8df0bf2 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    6027f97 View commit details
    Browse the repository at this point in the history