go

Author: lukegalbraithrussell

cmd/docs/docs.go

@@ -24,7 +24,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var searchFlag string
+var searchMode bool
 
 func NewCommand(clients *shared.ClientFactory) *cobra.Command {
 	cmd := &cobra.Command{
@@ -37,17 +37,25 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
 				Command: "docs",
 			},
 			{
-				Meaning: "Search Slack developer docs",
-				Command: "docs --search 'Block Kit'",
+				Meaning: "Open Slack docs search page",
+				Command: "docs --search",
+			},
+			{
+				Meaning: "Search Slack docs",
+				Command: "docs --search \"Block Kit\"",
+			},
+			{
+				Meaning: "Search Slack docs without search flag",
+				Command: "docs \"Block Kit\"",
 			},
 		}),
-		Args: cobra.NoArgs,
+		Args: cobra.MaximumNArgs(1), // Allow 0-1 arguments for search query
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runDocsCommand(clients, cmd, args)
 		},
 	}
 
-	cmd.Flags().StringVar(&searchFlag, "search", "", "search query for Slack docs")
+	cmd.Flags().BoolVar(&searchMode, "search", false, "open Slack docs search page")
 
 	return cmd
 }
@@ -59,13 +67,17 @@ func runDocsCommand(clients *shared.ClientFactory, cmd *cobra.Command, args []st
 	var docsURL string
 	var sectionText string
 
-	if searchFlag != "" {
-		// Build search URL
-		searchQuery := url.QueryEscape(searchFlag)
+	if len(args) > 0 {
+		// Search query provided as positional argument: slack docs "query"
+		searchQuery := url.QueryEscape(args[0])
 		docsURL = fmt.Sprintf("https://docs.slack.dev/search/?q=%s", searchQuery)
 		sectionText = "Docs Search"
+	} else if searchMode {
+		// Search flag provided without query: slack docs --search
+		docsURL = "https://docs.slack.dev/search/"
+		sectionText = "Docs Search"
 	} else {
-		// Default docs homepage
+		// Default homepage: slack docs
 		docsURL = "https://docs.slack.dev"
 		sectionText = "Docs Open"
 	}
@@ -80,8 +92,12 @@ func runDocsCommand(clients *shared.ClientFactory, cmd *cobra.Command, args []st
 
 	clients.Browser().OpenURL(docsURL)
 
-	if searchFlag != "" {
-		clients.IO.PrintTrace(ctx, slacktrace.DocsSearchSuccess, searchFlag)
+	if len(args) > 0 || searchMode {
+		traceValue := ""
+		if len(args) > 0 {
+			traceValue = args[0]
+		}
+		clients.IO.PrintTrace(ctx, slacktrace.DocsSearchSuccess, traceValue)
 	} else {
 		clients.IO.PrintTrace(ctx, slacktrace.DocsSuccess)
 	}

cmd/docs/docs_test.go

@@ -41,7 +41,7 @@ func Test_Docs_DocsCommand(t *testing.T) {
 			},
 		},
 		"opens docs with basic search query": {
-			CmdArgs: []string{"--search", "messaging"},
+			CmdArgs: []string{"messaging"},
 			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
 				expectedURL := "https://docs.slack.dev/search/?q=messaging"
 				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
@@ -53,7 +53,7 @@ func Test_Docs_DocsCommand(t *testing.T) {
 			},
 		},
 		"handles search query with multiple words": {
-			CmdArgs: []string{"--search", "socket mode"},
+			CmdArgs: []string{"socket mode"},
 			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
 				expectedURL := "https://docs.slack.dev/search/?q=socket+mode"
 				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
@@ -65,7 +65,7 @@ func Test_Docs_DocsCommand(t *testing.T) {
 			},
 		},
 		"handles special characters in search query": {
-			CmdArgs: []string{"--search", "messages & webhooks"},
+			CmdArgs: []string{"messages & webhooks"},
 			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
 				expectedURL := "https://docs.slack.dev/search/?q=messages+%26+webhooks"
 				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
@@ -77,7 +77,7 @@ func Test_Docs_DocsCommand(t *testing.T) {
 			},
 		},
 		"handles search query with quotes": {
-			CmdArgs: []string{"--search", "webhook \"send message\""},
+			CmdArgs: []string{"webhook \"send message\""},
 			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
 				expectedURL := "https://docs.slack.dev/search/?q=webhook+%22send+message%22"
 				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
@@ -88,16 +88,28 @@ func Test_Docs_DocsCommand(t *testing.T) {
 				"https://docs.slack.dev/search/?q=webhook+%22send+message%22",
 			},
 		},
-		"handles empty search query as homepage": {
-			CmdArgs: []string{"--search", ""},
+		"handles empty search query": {
+			CmdArgs: []string{""},
 			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
-				expectedURL := "https://docs.slack.dev"
+				expectedURL := "https://docs.slack.dev/search/?q="
 				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
-				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.DocsSuccess, mock.Anything)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.DocsSearchSuccess, mock.Anything)
 			},
 			ExpectedOutputs: []string{
-				"Docs Open",
-				"https://docs.slack.dev",
+				"Docs Search",
+				"https://docs.slack.dev/search/?q=",
+			},
+		},
+		"handles search flag without argument": {
+			CmdArgs: []string{"--search"},
+			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
+				expectedURL := "https://docs.slack.dev/search/"
+				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.DocsSearchSuccess, mock.Anything)
+			},
+			ExpectedOutputs: []string{
+				"Docs Search",
+				"https://docs.slack.dev/search/",
 			},
 		},
 	}, func(cf *shared.ClientFactory) *cobra.Command {