fix(help): add recovery hint for empty searches
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
7bf060986d
commit
c3f2d6abb7
2 changed files with 7 additions and 1 deletions
|
|
@ -65,6 +65,7 @@ func AddHelpCommands(root *cli.Command) {
|
||||||
query = strings.TrimSpace(strings.Join(args, " "))
|
query = strings.TrimSpace(strings.Join(args, " "))
|
||||||
}
|
}
|
||||||
if query == "" {
|
if query == "" {
|
||||||
|
renderHelpHint("")
|
||||||
return cli.Err("help search query is required")
|
return cli.Err("help search query is required")
|
||||||
}
|
}
|
||||||
return searchHelpTopics(catalog, query)
|
return searchHelpTopics(catalog, query)
|
||||||
|
|
|
||||||
|
|
@ -193,9 +193,14 @@ func TestAddHelpCommands_Bad(t *testing.T) {
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NotNil(t, cmd)
|
require.NotNil(t, cmd)
|
||||||
|
|
||||||
|
var err error
|
||||||
|
out := captureOutput(t, func() {
|
||||||
err = cmd.RunE(cmd, nil)
|
err = cmd.RunE(cmd, nil)
|
||||||
|
})
|
||||||
require.Error(t, err)
|
require.Error(t, err)
|
||||||
assert.Contains(t, err.Error(), "help search query is required")
|
assert.Contains(t, err.Error(), "help search query is required")
|
||||||
|
assert.Contains(t, out, "browse")
|
||||||
|
assert.Contains(t, out, "core help")
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("missing topic shows suggestions when available", func(t *testing.T) {
|
t.Run("missing topic shows suggestions when available", func(t *testing.T) {
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue