Merge pull request #90 from rsteube/schema-use-examples

schema: use `examples` to skip validation

action.go

@@ -4,15 +4,39 @@ import (
 	"fmt"
 	"os"
 	"regexp"
+	"sort"
 	"strings"
 
+	"github.com/invopop/jsonschema"
 	"github.com/rsteube/carapace"
 	"github.com/rsteube/carapace/pkg/style"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"gopkg.in/yaml.v3"
 )
 
+// static value or macro
+type action string
+
+func (action) JSONSchema() *jsonschema.Schema {
+	sortedNames := make([]string, 0, len(macros))
+	for name := range macros {
+		sortedNames = append(sortedNames, name)
+	}
+	sort.Strings(sortedNames)
+
+	examples := make([]interface{}, 0, len(macros))
+	for _, name := range sortedNames {
+		examples = append(examples, fmt.Sprintf("$%v(%v)", name, macros[name].Signature()))
+	}
+	return &jsonschema.Schema{
+		Type:        "string",
+		Title:       "Action",
+		Description: "A static value or a macro",
+		Examples:    examples,
+	}
+}
+
 // ActionMacro completes given macro
 func ActionMacro(s string) carapace.Action {
 	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {

command.go

@@ -1,27 +1,10 @@
 package spec
 
 import (
-	"github.com/invopop/jsonschema"
 	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 )
 
-// static value or macro
-type action string
-
-func (action) JSONSchema() *jsonschema.Schema {
-	enum := make([]interface{}, 0, len(macros))
-	for macro := range macros {
-		enum = append(enum, "$"+macro) // TODO full signature as in `carapace --macros XX`
-	}
-	return &jsonschema.Schema{
-		Type:        "string",
-		Title:       "Action",
-		Description: "A static value or a macro",
-		Enum:        enum,
-	}
-}
-
 type Command struct {
 	Name            string            `json:"name" jsonschema_description:"Name of the command"`
 	Aliases         []string          `json:"aliases,omitempty" jsonschema_description:"Aliases of the command"`