Skip to content

Argument Templates

00JCIV00 edited this page Apr 7, 2024 · 3 revisions

Argument Templates can be generated in the JSON and KDL formats for exporting Cova Arguments to another program to use however you see fit. This could be helpful supporting additional Help Doc and Tab Completion Script formats, or potentially importing these Arguments to other projects and programming languages.

Examples

Configuration

Help Docs are configured with the cova.generate.ArgTemplateConfig struct which can be set up directly in the Meta Doc Config using the cova.generate.MetaDocConfig.arg_template_config field. Within the Config, there are self-explanatory fields for configuring the following categories:

  • Generated Filepath
  • Project Info
  • Argument Inclusion Toggles

Usage

JSON

The JSON format has no specific usage. Its use-case stems from this discussion, but the format is flexible enough to be used nearly anywhere.

KDL

This format is designed based on the usage tool/spec. More details can also be found here.