fix: generated cli examples

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

docs/user/commands/kyverno-json_jp.md

@@ -35,6 +35,6 @@ kyverno-json jp [flags]
 
 * [kyverno-json](kyverno-json.md)	 - kyverno-json
 * [kyverno-json jp function](kyverno-json_jp_function.md)	 - Provides function informations.
-* [kyverno-json jp parse](kyverno-json_jp_parse.md)	 - Parses jmespath expression and shows corresponding AST.
+* [kyverno-json jp parse](kyverno-json_jp_parse.md)	 - Parses jmespath expression and prints corresponding AST.
 * [kyverno-json jp query](kyverno-json_jp_query.md)	 - Provides a command-line interface to JMESPath, enhanced with Kyverno specific custom functions.
 

docs/user/commands/kyverno-json_jp_function.md

@@ -15,10 +15,10 @@ kyverno-json jp function [function_name]... [flags]
 
 ```
   # List functions
-  jp function
+  kyverno-json jp function
 
   # Get function infos
-  jp function truncate
+  kyverno-json jp function truncate
 
 ```
 

docs/user/commands/kyverno-json_jp_parse.md

@@ -1,15 +1,33 @@
 ## kyverno-json jp parse
 
-Parses jmespath expression and shows corresponding AST.
+Parses jmespath expression and prints corresponding AST.
 
 ### Synopsis
 
-Parses jmespath expression and shows corresponding AST.
+Parses jmespath expression and prints corresponding AST.
+
 
 ```
 kyverno-json jp parse [-f file|expression]... [flags]
 ```
 
+### Examples
+
+```
+  # Parse expression
+  kyverno-json jp parse 'request.object.metadata.name | truncate(@, `9`)'
+
+  # Parse expression from a file
+  kyverno-json jp parse -f my-file
+
+  # Parse expression from stdin
+  kyverno-json jp parse
+
+  # Parse multiple expressionxs
+  kyverno-json jp parse -f my-file1 -f my-file-2 'request.object.metadata.name | truncate(@, `9`)'
+
+```
+
 ### Options
 
 ```

docs/user/commands/kyverno-json_jp_query.md

@@ -6,10 +6,25 @@ Provides a command-line interface to JMESPath, enhanced with Kyverno specific cu
 
 Provides a command-line interface to JMESPath, enhanced with Kyverno specific custom functions.
 
+
 ```
 kyverno-json jp query [-i input] [-q query|query]... [flags]
 ```
 
+### Examples
+
+```
+  # Evaluate query
+  kyverno-json jp query -i object.yaml 'request.object.metadata.name | truncate(@, `9`)'
+
+  # Evaluate query
+  kyverno-json jp query -i object.yaml -q query-file
+
+  # Evaluate multiple queries
+  kyverno-json jp query -i object.yaml -q query-file-1 -q query-file-2 'request.object.metadata.name | truncate(@, `9`)'
+
+```
+
 ### Options
 
 ```

pkg/command/command.go

@@ -2,23 +2,18 @@ package command
 
 import (
 	"strings"
-
-	"github.com/spf13/cobra"
 )
 
 type Command struct {
-	parent       *cobra.Command
+	parents      []string
 	experimental bool
 	description  []string
 	websiteUrl   string
 	examples     []Example
 }
 
-func new(parent *cobra.Command, experimental bool, options ...option) Command {
-	cmd := Command{
-		parent:       parent,
-		experimental: experimental,
-	}
+func New(options ...option) Command {
+	var cmd Command
 	for _, opt := range options {
 		if opt != nil {
 			opt(&cmd)
@@ -27,14 +22,6 @@ func new(parent *cobra.Command, experimental bool, options ...option) Command {
 	return cmd
 }
 
-func New(parent *cobra.Command, options ...option) Command {
-	return new(parent, false, options...)
-}
-
-func NewExperimental(parent *cobra.Command, options ...option) Command {
-	return new(parent, true, options...)
-}
-
 func Description(c Command, short bool) string {
 	if len(c.description) == 0 {
 		return ""
@@ -59,8 +46,8 @@ func Examples(c Command) string {
 		return ""
 	}
 	var useLine string
-	if c.parent != nil {
-		useLine = c.parent.UseLine() + " "
+	if len(c.parents) != 0 {
+		useLine = strings.Join(c.parents, " ") + " "
 	}
 	var lines []string
 	for _, example := range c.examples {

pkg/command/option.go

@@ -22,3 +22,15 @@ func WithExample(title, command string) option {
 		})
 	}
 }
+
+func WithExperimental(experimental bool) option {
+	return func(d *Command) {
+		d.experimental = experimental
+	}
+}
+
+func WithParents(parents ...string) option {
+	return func(d *Command) {
+		d.parents = parents
+	}
+}

pkg/commands/docs/command.go

@@ -7,10 +7,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func Command(parent *cobra.Command) *cobra.Command {
+func Command(parents ...string) *cobra.Command {
 	var options options
 	doc := command.New(
-		parent,
+		command.WithParents(parents...),
 		command.WithDescription(
 			"Generates reference documentation.",
 			"The docs command generates CLI reference documentation.",
@@ -33,15 +33,7 @@ func Command(parent *cobra.Command) *cobra.Command {
 		Args:         cobra.NoArgs,
 		SilenceUsage: true,
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			root := parent
-			if root != nil {
-				for {
-					if !root.HasParent() {
-						break
-					}
-					root = root.Parent()
-				}
-			}
+			root := cmd.Root()
 			if err := options.validate(root); err != nil {
 				return err
 			}

pkg/commands/docs/command_test.go

@@ -6,27 +6,18 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
 )
 
-func TestCommandWithNilRoot(t *testing.T) {
-	cmd := Command(nil)
-	assert.NotNil(t, cmd)
-	cmd.SetArgs([]string{"-o", "foo"})
-	err := cmd.Execute()
-	assert.Error(t, err)
-}
-
 func TestCommandWithoutArgs(t *testing.T) {
-	cmd := Command(&cobra.Command{})
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	err := cmd.Execute()
 	assert.Error(t, err)
 }
 
 func TestCommandWithInvalidArg(t *testing.T) {
-	cmd := Command(&cobra.Command{})
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetErr(b)
@@ -40,7 +31,7 @@ func TestCommandWithInvalidArg(t *testing.T) {
 }
 
 func TestCommandWithInvalidFlag(t *testing.T) {
-	cmd := Command(&cobra.Command{})
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetErr(b)
@@ -54,7 +45,7 @@ func TestCommandWithInvalidFlag(t *testing.T) {
 }
 
 func TestCommandHelp(t *testing.T) {
-	cmd := Command(&cobra.Command{})
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetOut(b)

pkg/commands/jp/command.go

@@ -8,9 +8,9 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func Command(parent *cobra.Command) *cobra.Command {
+func Command(parents ...string) *cobra.Command {
 	doc := command.New(
-		parent,
+		command.WithParents(parents...),
 		command.WithDescription("Provides a command-line interface to JMESPath, enhanced with custom functions."),
 		command.WithExample("List functions", "jp function"),
 		command.WithExample("Evaluate query", "jp query -i object.yaml 'request.object.metadata.name | truncate(@, `9`)'"),
@@ -28,9 +28,9 @@ func Command(parent *cobra.Command) *cobra.Command {
 		},
 	}
 	cmd.AddCommand(
-		function.Command(cmd),
-		parse.Command(),
-		query.Command(),
+		function.Command(append(parents, "jp")...),
+		parse.Command(append(parents, "jp")...),
+		query.Command(append(parents, "jp")...),
 	)
 	return cmd
 }

pkg/commands/jp/command_test.go

@@ -10,22 +10,22 @@ import (
 )
 
 func TestCommand(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	err := cmd.Execute()
 	assert.NoError(t, err)
 }
 
 func TestCommandWithArgs(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	cmd.SetArgs([]string{"foo"})
 	err := cmd.Execute()
 	assert.Error(t, err)
 }
 
 func TestCommandWithInvalidArg(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetErr(b)
@@ -39,7 +39,7 @@ func TestCommandWithInvalidArg(t *testing.T) {
 }
 
 func TestCommandWithInvalidFlag(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetErr(b)
@@ -53,7 +53,7 @@ func TestCommandWithInvalidFlag(t *testing.T) {
 }
 
 func TestCommandHelp(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetOut(b)

pkg/commands/jp/function/command.go

@@ -15,9 +15,9 @@ import (
 	"k8s.io/apimachinery/pkg/util/sets"
 )
 
-func Command(parent *cobra.Command) *cobra.Command {
+func Command(parents ...string) *cobra.Command {
 	doc := command.New(
-		parent,
+		command.WithParents(parents...),
 		command.WithDescription("Provides function informations."),
 		command.WithExample("List functions", "function"),
 		command.WithExample("Get function infos", "function truncate"),

pkg/commands/jp/function/command_test.go

@@ -10,30 +10,30 @@ import (
 )
 
 func TestCommand(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	err := cmd.Execute()
 	assert.NoError(t, err)
 }
 
 func TestCommandWithOneArg(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	cmd.SetArgs([]string{"truncate"})
 	err := cmd.Execute()
 	assert.NoError(t, err)
 }
 
 func TestCommandWithArgs(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	cmd.SetArgs([]string{"truncate", "to_upper"})
 	err := cmd.Execute()
 	assert.NoError(t, err)
 }
 
 func TestCommandWithInvalidFlag(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetErr(b)
@@ -47,7 +47,7 @@ func TestCommandWithInvalidFlag(t *testing.T) {
 }
 
 func TestCommandHelp(t *testing.T) {
-	cmd := Command(nil)
+	cmd := Command()
 	assert.NotNil(t, cmd)
 	b := bytes.NewBufferString("")
 	cmd.SetOut(b)

pkg/commands/jp/parse/command.go

@@ -7,15 +7,25 @@ import (
 	"path/filepath"
 
 	"github.com/jmespath-community/go-jmespath/pkg/parsing"
+	"github.com/kyverno/kyverno-json/pkg/command"
 	"github.com/spf13/cobra"
 )
 
-func Command() *cobra.Command {
+func Command(parents ...string) *cobra.Command {
+	doc := command.New(
+		command.WithParents(parents...),
+		command.WithDescription("Parses jmespath expression and prints corresponding AST."),
+		command.WithExample("Parse expression", "parse 'request.object.metadata.name | truncate(@, `9`)'"),
+		command.WithExample("Parse expression from a file", "parse -f my-file"),
+		command.WithExample("Parse expression from stdin", "parse"),
+		command.WithExample("Parse multiple expressionxs", "parse -f my-file1 -f my-file-2 'request.object.metadata.name | truncate(@, `9`)'"),
+	)
 	var files []string
 	cmd := &cobra.Command{
 		Use:          "parse [-f file|expression]...",
-		Short:        "Parses jmespath expression and shows corresponding AST.",
-		Long:         "Parses jmespath expression and shows corresponding AST.",
+		Short:        command.Description(doc, true),
+		Long:         command.Description(doc, false),
+		Example:      command.Examples(doc),
 		SilenceUsage: true,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			expressions, err := loadExpressions(cmd, args, files)