Merge pull request #269 from rsteube/spec-documentation

spec: add documentation fields
carapace-sh · Mar 3, 2024 · 76c9a66 · 76c9a66
2 parents f296080 + 58b07bb
commit 76c9a66
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/pkg/command/command.go b/pkg/command/command.go
@@ -20,6 +20,16 @@ type Command struct {
 		DashAny       []string            `yaml:"dashany,omitempty" json:"dashany,omitempty" jsonschema_description:"Dash completion of every other position"`
 	} `yaml:"completion,omitempty" json:"completion,omitempty" jsonschema_description:"Completion definition"`
 	Commands []Command `yaml:"commands,omitempty" json:"commands,omitempty" jsonschema_description:"Subcommands of the command"`
+
+	Documentation struct {
+		Command       string            `yaml:"command,omitempty" json:"command,omitempty" jsonschema_description:"Documentation of the command"`
+		Flag          map[string]string `yaml:"flag,omitempty" json:"flag,omitempty" jsonschema_description:"Documentation of flags"`
+		Positional    []string          `yaml:"positional,omitempty" json:"positional,omitempty" jsonschema_description:"Documentation of positional arguments"`
+		PositionalAny string            `yaml:"positionalany,omitempty" json:"positionalany,omitempty" jsonschema_description:"Documentation of other positional arguments"`
+		Dash          []string          `yaml:"dash,omitempty" json:"dash,omitempty" jsonschema_description:"Documentation of dash arguments"`
+		DashAny       string            `yaml:"dashany,omitempty" json:"dashany,omitempty" jsonschema_description:"Documentation of other dash arguments"`
+	} `yaml:"documentation,omitempty" json:"documentation,omitempty" jsonschema_description:"Documentation"`
+	Examples map[string]string `yaml:"examples,omitempty" json:"examples,omitempty" jsonschema_description:"Examples"`
 }
 
 func (c *Command) AddFlag(f Flag) {