Skip to content

Commit 37fbf2a

Browse files
authored
chore: improve output for plugin subcommand (#231)
1 parent 92ce86b commit 37fbf2a

2 files changed

Lines changed: 17 additions & 7 deletions

File tree

cmd/plugin.go

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ func (o *PluginListOptions) Run() error {
7979

8080
pluginWarnings := 0
8181
for _, pluginPath := range plugins {
82-
fmt.Fprintf(o.Out, "%s\n", pluginPath)
82+
fmt.Fprintf(o.Out, "%-40s (%s)\n", pluginToCommand(pluginPath), filepath.Dir(pluginPath))
8383
if errs := o.Verifier.Verify(pluginPath); len(errs) != 0 {
8484
for _, err := range errs {
8585
fmt.Fprintf(o.ErrOut, " - %s\n", err)
@@ -120,7 +120,6 @@ func (o *PluginListOptions) ListPlugins() ([]string, []error) {
120120
if err != nil {
121121
var pathErr *os.PathError
122122
if errors.As(err, &pathErr) {
123-
fmt.Fprintf(o.ErrOut, "Unable to read directory %q from your PATH: %v. Skipping...\n", dir, err)
124123
continue
125124
}
126125

@@ -235,3 +234,14 @@ func hasValidPrefix(filename string) bool {
235234
}
236235
return false
237236
}
237+
238+
func pluginToCommand(pluginPath string) string {
239+
name := filepath.Base(pluginPath)
240+
name = strings.TrimPrefix(name, PluginPrefix+"-")
241+
parts := strings.Split(name, "-")
242+
for i, p := range parts {
243+
parts[i] = strings.ReplaceAll(p, "_", "-")
244+
}
245+
return PluginPrefix + " " + strings.Join(parts, " ")
246+
}
247+

test/plugin_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,11 @@ var _ = Describe("plugin", func() {
5454
sess := r.run("plugin", "list")
5555
Expect(sess.Out).To(SatisfyAll(
5656
gbytes.Say("The following compatible plugins are available:"),
57-
gbytes.Say("kratix-cat"),
58-
gbytes.Say("kratix-error"),
59-
gbytes.Say("kratix-hi"),
57+
gbytes.Say("kratix cat"),
58+
gbytes.Say("kratix error"),
59+
gbytes.Say("kratix hi"),
6060
))
61+
Expect(string(sess.Out.Contents())).To(ContainSubstring(workingDir))
6162
})
6263
})
6364

@@ -76,8 +77,7 @@ var _ = Describe("plugin", func() {
7677

7778
Expect(sess.Err).NotTo(gbytes.Say("overshadowed by a similarly named plugin"))
7879

79-
pluginPath := filepath.Join(workingDir, "kratix-hi")
80-
Expect(strings.Count(string(sess.Out.Contents()), pluginPath)).To(Equal(1))
80+
Expect(strings.Count(string(sess.Out.Contents()), "kratix hi")).To(Equal(1))
8181
})
8282
})
8383
})

0 commit comments

Comments
 (0)