add 'src search' command for using Sourcegraph search from the command line

This adds a 'src search' subcommand for two primary use cases:

1. Searching from the command line (the default, `src search 'some query'`).
2. Getting results from our search API without having to specify all the GraphQL fields (via the json flag, `src search -json 'some query'`).

For usage information, consult `src search -h`:

> Usage of 'src search':
>   -explain-json
>         Explain the JSON output schema and exit.
>   -get-curl
>         Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
>   -json
>         Whether or not to output results as JSON
>   -less
>         Pipe output to 'less -R' (only if stdout is terminal) (default true)
>
> Examples:
>
>   Perform a search and get results:
>
>         $ src search 'repogroup:sample error'
>
>   Perform a search and get results as JSON:
>
>         $ src search -json 'repogroup:sample error'
>
> Other tips:
>
>   Make 'type:diff' searches have colored diffs by installing https://colordiff.org
>     - Ubuntu/Debian: $ sudo apt-get install colordiff
>     - Mac OS:        $ brew install colordiff
>
>   Disable color output by setting NO_COLOR=t (see https://no-color.org).
>
>   Force color output on (not on by default when piped to other programs) by setting COLOR=t
>
>   Query syntax: https://about.sourcegraph.com/docs/search/query-syntax/
>

Author: Stephen Gutekanst

cmd/src/.gitignore

@@ -0,0 +1 @@
+*.got.txt

cmd/src/colors.go

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"regexp"
+	"strconv"
+
+	"github.com/mattn/go-isatty"
+)
+
+// Returns the string for a foreground ANSI 8 bit color code.
+func fg256Color(code int) string {
+	return fmt.Sprintf("\033[38;5;%dm", code)
+}
+
+// Returns the string for a background ANSI 8 bit color code.
+func bg256Color(code int) string {
+	return fmt.Sprintf("\033[48;5;%dm", code)
+}
+
+// See https://i.stack.imgur.com/KTSQa.png or https://jonasjacek.github.io/colors/
+var ansiColors = map[string]string{
+	"nc":      "\033[0m",
+	"logo":    fg256Color(57),
+	"warning": fg256Color(124),
+	"success": fg256Color(2),
+
+	// Search-specific colors.
+	"search-query":          fg256Color(68),
+	"search-border":         fg256Color(239),
+	"search-link":           fg256Color(237),
+	"search-repository":     fg256Color(23),
+	"search-filename":       fg256Color(69),
+	"search-match":          fg256Color(0) + bg256Color(2),
+	"search-line-numbers":   fg256Color(69),
+	"search-commit-author":  fg256Color(2),
+	"search-commit-subject": fg256Color(68),
+	"search-commit-date":    fg256Color(23),
+}
+
+// Borrowed from https://github.com/acarl005/stripansi/blob/master/stripansi.go
+// MIT licensed, see https://github.com/acarl005/stripansi/blob/master/LICENSE
+var ansiRegexp = regexp.MustCompile("[\u001B\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))")
+
+var isTest bool
+var colorDisabled bool
+
+func init() {
+	if !isTest {
+		// We comply with the no-color.org spec here.
+		if os.Getenv("NO_COLOR") != "" {
+			colorDisabled = true
+		} else {
+			// If they specify COLOR=true or COLOR=false, we respect that.
+			if color := os.Getenv("COLOR"); color != "" {
+				colorEnabled, _ := strconv.ParseBool(color)
+				colorDisabled = !colorEnabled
+			} else {
+				// If our program is being piped into another one, then disable
+				// color. This is usually desired, and can be overridden with COLOR=true.
+				colorDisabled = !isatty.IsTerminal(os.Stdout.Fd())
+			}
+		}
+	}
+	if colorDisabled {
+		for color := range ansiColors {
+			ansiColors[color] = ""
+		}
+	}
+
+	if os.Getenv("DEBUG_PRINT_COLORS") == "t" {
+		fmt.Println("The following colors are available:")
+		for color, code := range ansiColors {
+			if color == "nc" {
+				continue
+			}
+			fmt.Println(code + color + ansiColors["nc"])
+		}
+		os.Exit(1)
+	}
+}

cmd/src/format.go

@@ -4,16 +4,85 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"strings"
 	"text/template"
+	"time"
+
+	humanize "github.com/dustin/go-humanize"
 )
 
 func parseTemplate(text string) (*template.Template, error) {
 	tmpl := template.New("")
 	tmpl.Funcs(map[string]interface{}{
+		"join": strings.Join,
 		"json": func(v interface{}) (string, error) {
-			b, err := json.MarshalIndent(v, "", "  ")
+			b, err := marshalIndent(v)
 			return string(b), err
 		},
+		"msDuration": func(ms int) time.Duration {
+			return time.Duration(ms) * time.Millisecond
+		},
+		"repoNames": func(repos []map[string]interface{}) (names []string) {
+			for _, r := range repos {
+				names = append(names, r["name"].(string))
+			}
+			return
+		},
+		"pad": func(value interface{}, padding int, padCharacter string) string {
+			val := fmt.Sprint(value)
+			repeat := padding - len(val)
+			if repeat < 0 {
+				repeat = 0
+			}
+			return strings.Repeat(padCharacter, repeat) + val
+		},
+		"padRight": func(value interface{}, padding int, padCharacter string) string {
+			val := fmt.Sprint(value)
+			repeat := padding - len(val)
+			if repeat < 0 {
+				repeat = 0
+			}
+			return val + strings.Repeat(padCharacter, repeat)
+		},
+		"indent": func(lines, indention string) string {
+			split := strings.Split(lines, "\n")
+			for i, l := range split {
+				if l != "" {
+					split[i] = indention + l
+				}
+			}
+			return strings.Join(split, "\n")
+		},
+		"addFloat": func(x, y float64) float64 {
+			return x + y
+		},
+		"debug": func(v interface{}) string {
+			data, _ := marshalIndent(v)
+			fmt.Println(string(data))
+
+			// Template functions must return something. In our case, it is
+			// useful to actually print the string above now as the template
+			// could fail due to e.g. syntax errors that someone is trying to
+			// debug,and we want the spew above to show regardless.
+			return ""
+		},
+		"color": func(name string) string {
+			return ansiColors[name]
+		},
+		"humanizeRFC3339": func(date string) (string, error) {
+			t, err := time.Parse(time.RFC3339, date)
+			if err != nil {
+				return "", err
+			}
+			return humanize.Time(t), nil
+		},
+
+		// Register search-specific template functions
+		"searchSequentialLineNumber": searchTemplateFuncs["searchSequentialLineNumber"],
+		"searchHighlightMatch":       searchTemplateFuncs["searchHighlightMatch"],
+		"searchHighlightPreview":     searchTemplateFuncs["searchHighlightPreview"],
+		"searchHighlightDiffPreview": searchTemplateFuncs["searchHighlightDiffPreview"],
+		"searchMaxRepoNameLength":    searchTemplateFuncs["searchMaxRepoNameLength"],
 	})
 	return tmpl.Parse(text)
 }

cmd/src/main.go

@@ -26,6 +26,7 @@ The options are:
 
 The commands are:
 
+	search        search for results on Sourcegraph
 	api           interacts with the Sourcegraph GraphQL API
 	repos,repo    manages repositories
 	users,user    manages users