Some nits (#29)

* Add installation hint about shell completion * Replace usage of deprecated `genericiooptions.IOStreams` * Replace usage of deprecated `term.AllowsColorOutput` * Nits in `PrintFlags`
timebertt · Jun 3, 2024 · d6a2a42 · d6a2a42
1 parent 1de8d32
commit d6a2a42
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,12 @@ Using go:
 go install github.com/timebertt/kubectl-revisions@latest
 ```
 
+Learn how to set up shell completion:
+
+```bash
+kubectl revisions completion -h
+```
+
 ## Usage
 
 ### `k revisions get` / `k revisions list`

diff --git a/pkg/cmd/completion/completion.go b/pkg/cmd/completion/completion.go
@@ -4,24 +4,24 @@ import (
 	_ "embed"
 
 	"github.com/spf13/cobra"
-	"k8s.io/cli-runtime/pkg/genericclioptions"
+	"k8s.io/cli-runtime/pkg/genericiooptions"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 )
 
 //go:embed kubectl_complete-revisions
 var completionScript []byte
 
 type Options struct {
-	genericclioptions.IOStreams
+	genericiooptions.IOStreams
 }
 
-func NewOptions(streams genericclioptions.IOStreams) *Options {
+func NewOptions(streams genericiooptions.IOStreams) *Options {
 	return &Options{
 		IOStreams: streams,
 	}
 }
 
-func NewCommand(streams genericclioptions.IOStreams) *cobra.Command {
+func NewCommand(streams genericiooptions.IOStreams) *cobra.Command {
 	o := NewOptions(streams)
 
 	cmd := &cobra.Command{

diff --git a/pkg/cmd/diff/diff.go b/pkg/cmd/diff/diff.go
@@ -9,7 +9,7 @@ import (
 
 	"github.com/spf13/cobra"
 	corev1 "k8s.io/api/core/v1"
-	"k8s.io/cli-runtime/pkg/genericclioptions"
+	"k8s.io/cli-runtime/pkg/genericiooptions"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 	utilcomp "k8s.io/kubectl/pkg/util/completion"
 	"k8s.io/utils/exec"
@@ -22,7 +22,7 @@ import (
 )
 
 type Options struct {
-	genericclioptions.IOStreams
+	genericiooptions.IOStreams
 
 	Namespace  string
 	Revisions  []int64
@@ -31,7 +31,7 @@ type Options struct {
 	Diff diff.Program
 }
 
-func NewOptions(streams genericclioptions.IOStreams) *Options {
+func NewOptions(streams genericiooptions.IOStreams) *Options {
 	printFlags := util.NewPrintFlags()
 	printFlags.WithDefaultOutput("yaml")
 	printFlags.TemplateOnly = true
@@ -47,7 +47,7 @@ func NewOptions(streams genericclioptions.IOStreams) *Options {
 	}
 }
 
-func NewCommand(f util.Factory, streams genericclioptions.IOStreams) *cobra.Command {
+func NewCommand(f util.Factory, streams genericiooptions.IOStreams) *cobra.Command {
 	o := NewOptions(streams)
 
 	cmd := &cobra.Command{

diff --git a/pkg/cmd/get/get.go b/pkg/cmd/get/get.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 
 	"github.com/spf13/cobra"
-	"k8s.io/cli-runtime/pkg/genericclioptions"
+	"k8s.io/cli-runtime/pkg/genericiooptions"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 	utilcomp "k8s.io/kubectl/pkg/util/completion"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -16,14 +16,14 @@ import (
 )
 
 type Options struct {
-	genericclioptions.IOStreams
+	genericiooptions.IOStreams
 
 	Namespace  string
 	Revision   int64
 	PrintFlags *util.PrintFlags
 }
 
-func NewOptions(streams genericclioptions.IOStreams) *Options {
+func NewOptions(streams genericiooptions.IOStreams) *Options {
 	printFlags := util.NewPrintFlags()
 
 	return &Options{
@@ -32,7 +32,7 @@ func NewOptions(streams genericclioptions.IOStreams) *Options {
 	}
 }
 
-func NewCommand(f util.Factory, streams genericclioptions.IOStreams) *cobra.Command {
+func NewCommand(f util.Factory, streams genericiooptions.IOStreams) *cobra.Command {
 	o := NewOptions(streams)
 
 	cmd := &cobra.Command{

diff --git a/pkg/cmd/root.go b/pkg/cmd/root.go
@@ -6,10 +6,11 @@ import (
 
 	"github.com/spf13/cobra"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
+	"k8s.io/cli-runtime/pkg/genericiooptions"
+	"k8s.io/cli-runtime/pkg/printers"
 	"k8s.io/client-go/rest"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 	utilcomp "k8s.io/kubectl/pkg/util/completion"
-	"k8s.io/kubectl/pkg/util/term"
 
 	"github.com/timebertt/kubectl-revisions/pkg/cmd/completion"
 	"github.com/timebertt/kubectl-revisions/pkg/cmd/diff"
@@ -19,14 +20,14 @@ import (
 )
 
 type Options struct {
-	genericclioptions.IOStreams
+	genericiooptions.IOStreams
 
 	ConfigFlags *genericclioptions.ConfigFlags
 }
 
 func NewOptions() *Options {
 	return &Options{
-		IOStreams:   genericclioptions.IOStreams{In: os.Stdin, Out: os.Stdout, ErrOut: os.Stderr},
+		IOStreams:   genericiooptions.IOStreams{In: os.Stdin, Out: os.Stdout, ErrOut: os.Stderr},
 		ConfigFlags: genericclioptions.NewConfigFlags(true).WithDeprecatedPasswordFlag().WithDiscoveryBurst(300).WithDiscoveryQPS(50.0),
 	}
 }
@@ -39,7 +40,7 @@ func NewCommand() *cobra.Command {
 		Short: "Time-travel through your workload revision history",
 
 		PersistentPreRunE: func(*cobra.Command, []string) error {
-			warningHandler := rest.NewWarningWriter(o.IOStreams.ErrOut, rest.WarningWriterOptions{Deduplicate: true, Color: term.AllowsColorOutput(o.IOStreams.ErrOut)})
+			warningHandler := rest.NewWarningWriter(o.IOStreams.ErrOut, rest.WarningWriterOptions{Deduplicate: true, Color: printers.AllowsColorOutput(o.IOStreams.ErrOut)})
 			rest.SetDefaultWarningHandler(warningHandler)
 			return nil
 		},

diff --git a/pkg/cmd/util/print_flags.go b/pkg/cmd/util/print_flags.go
@@ -74,12 +74,12 @@ func (f *PrintFlags) OutputUsage() string {
 	if f.CustomColumnsFlags != nil {
 		usage += "custom columns [https://kubernetes.io/docs/reference/kubectl/#custom-columns], "
 	}
-	usage += "golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/]."
+	usage += "golang template [https://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/]."
 
 	return usage
 }
 
-// SetKind sets the Kind option of humanreadable flags
+// SetKind sets the Kind option of human-readable flags
 func (f *PrintFlags) SetKind(kind schema.GroupKind) {
 	f.TableFlags.SetKind(kind)
 }

diff --git a/pkg/cmd/version/version.go b/pkg/cmd/version/version.go
@@ -5,7 +5,7 @@ import (
 	"runtime/debug"
 
 	"github.com/spf13/cobra"
-	"k8s.io/cli-runtime/pkg/genericclioptions"
+	"k8s.io/cli-runtime/pkg/genericiooptions"
 )
 
 // version can be set via:
@@ -24,16 +24,16 @@ func init() {
 }
 
 type Options struct {
-	genericclioptions.IOStreams
+	genericiooptions.IOStreams
 }
 
-func NewOptions(streams genericclioptions.IOStreams) *Options {
+func NewOptions(streams genericiooptions.IOStreams) *Options {
 	return &Options{
 		IOStreams: streams,
 	}
 }
 
-func NewCommand(streams genericclioptions.IOStreams) *cobra.Command {
+func NewCommand(streams genericiooptions.IOStreams) *cobra.Command {
 	o := NewOptions(streams)
 
 	return &cobra.Command{

diff --git a/pkg/diff/program.go b/pkg/diff/program.go
@@ -1,7 +1,7 @@
 package diff
 
 import (
-	"k8s.io/cli-runtime/pkg/genericclioptions"
+	"k8s.io/cli-runtime/pkg/genericiooptions"
 	kubectldiff "k8s.io/kubectl/pkg/cmd/diff"
 	"k8s.io/utils/exec"
 )
@@ -14,7 +14,7 @@ type Program interface {
 
 // NewProgram returns kubectl's default Program implementation that respects the KUBECTL_EXTERNAL_DIFF environment
 // variable. It falls back to `diff -u -N` if the env var is unset.
-func NewProgram(streams genericclioptions.IOStreams) Program {
+func NewProgram(streams genericiooptions.IOStreams) Program {
 	return &kubectldiff.DiffProgram{
 		Exec:      exec.New(),
 		IOStreams: streams,