feat: implement `--all` flag

Implement an `--all` flag that can be used to view cheatsheets on all
chaetpaths. (Resolves #548)

cmd/cheat/cmd_view.go

@@ -30,9 +30,37 @@ func cmdView(opts map[string]interface{}, conf config.Config) {
 		)
 	}
 
-	// consolidate the cheatsheets found on all paths into a single map of
-	// `title` => `sheet` (ie, allow more local cheatsheets to override less
-	// local cheatsheets)
+	// if --all was passed, display cheatsheets from all cheatpaths
+	if opts["--all"].(bool) {
+		// iterate over the cheatpaths
+		for _, cheatpath := range cheatsheets {
+
+			// if the cheatpath contains the specified cheatsheet, display it
+			if sheet, ok := cheatpath[cheatsheet]; ok {
+
+				// identify the matching cheatsheet
+				fmt.Println(fmt.Sprintf("%s %s",
+					display.Underline(sheet.Title),
+					display.Faint(fmt.Sprintf("(%s)", sheet.CheatPath)),
+				))
+
+				// apply colorization if requested
+				if conf.Color(opts) {
+					sheet.Colorize(conf)
+				}
+
+				// display the cheatsheet
+				display.Display(display.Indent(sheet.Text), conf)
+			}
+		}
+
+		// exit early
+		os.Exit(0)
+	}
+
+	// otherwise, consolidate the cheatsheets found on all paths into a single
+	// map of `title` => `sheet` (ie, allow more local cheatsheets to override
+	// less local cheatsheets)
 	consolidated := sheets.Consolidate(cheatsheets)
 
 	// fail early if the requested cheatsheet does not exist

cmd/cheat/docopt.txt

@@ -3,11 +3,12 @@ Usage:
 
 Options:
   --init                  Write a default config file to stdout
+  -a --all                Search among all cheatpaths
   -c --colorize           Colorize output
   -d --directories        List cheatsheet directories
   -e --edit=<cheatsheet>  Edit <cheatsheet>
   -l --list               List cheatsheets
-  -p --path=<name>        Return only sheets found on path <name>
+  -p --path=<name>        Return only sheets found on cheatpath <name>
   -r --regex              Treat search <phrase> as a regex
   -s --search=<phrase>    Search cheatsheets for <phrase>
   -t --tag=<tag>          Return only sheets matching <tag>

cmd/cheat/str_usage.go

@@ -12,11 +12,12 @@ func usage() string {
 
 Options:
   --init                  Write a default config file to stdout
+  -a --all                Search among all cheatpaths
   -c --colorize           Colorize output
   -d --directories        List cheatsheet directories
   -e --edit=<cheatsheet>  Edit <cheatsheet>
   -l --list               List cheatsheets
-  -p --path=<name>        Return only sheets found on path <name>
+  -p --path=<name>        Return only sheets found on cheatpath <name>
   -r --regex              Treat search <phrase> as a regex
   -s --search=<phrase>    Search cheatsheets for <phrase>
   -t --tag=<tag>          Return only sheets matching <tag>

internal/sheet/copy_test.go

@@ -25,7 +25,7 @@ func TestCopyFlat(t *testing.T) {
 	}
 
 	// mock a cheatsheet struct
-	sheet, err := New("foo", src.Name(), []string{}, false)
+	sheet, err := New("foo", "community", src.Name(), []string{}, false)
 	if err != nil {
 		t.Errorf("failed to init cheatsheet: %v", err)
 	}
@@ -72,7 +72,13 @@ func TestCopyDeep(t *testing.T) {
 	}
 
 	// mock a cheatsheet struct
-	sheet, err := New("/cheat-tests/alpha/bravo/foo", src.Name(), []string{}, false)
+	sheet, err := New(
+		"/cheat-tests/alpha/bravo/foo",
+		"community",
+		src.Name(),
+		[]string{},
+		false,
+	)
 	if err != nil {
 		t.Errorf("failed to init cheatsheet: %v", err)
 	}

internal/sheet/sheet.go

@@ -10,17 +10,19 @@ import (
 
 // Sheet encapsulates sheet information
 type Sheet struct {
-	Title    string
-	Path     string
-	Text     string
-	Tags     []string
-	Syntax   string
-	ReadOnly bool
+	Title     string
+	CheatPath string
+	Path      string
+	Text      string
+	Tags      []string
+	Syntax    string
+	ReadOnly  bool
 }
 
 // New initializes a new Sheet
 func New(
 	title string,
+	cheatpath string,
 	path string,
 	tags []string,
 	readOnly bool,
@@ -46,11 +48,12 @@ func New(
 
 	// initialize and return a sheet
 	return Sheet{
-		Title:    title,
-		Path:     path,
-		Text:     text + "\n",
-		Tags:     tags,
-		Syntax:   fm.Syntax,
-		ReadOnly: readOnly,
+		Title:     title,
+		CheatPath: cheatpath,
+		Path:      path,
+		Text:      text + "\n",
+		Tags:      tags,
+		Syntax:    fm.Syntax,
+		ReadOnly:  readOnly,
 	}, nil
 }

internal/sheet/sheet_test.go

@@ -13,6 +13,7 @@ func TestSheetSuccess(t *testing.T) {
 	// initialize a sheet
 	sheet, err := New(
 		"foo",
+		"community",
 		mock.Path("sheet/foo"),
 		[]string{"alpha", "bravo"},
 		false,
@@ -61,6 +62,7 @@ func TestSheetFailure(t *testing.T) {
 	// initialize a sheet
 	_, err := New(
 		"foo",
+		"community",
 		mock.Path("/does-not-exist"),
 		[]string{"alpha", "bravo"},
 		false,
@@ -77,6 +79,7 @@ func TestSheetFrontMatterFailure(t *testing.T) {
 	// initialize a sheet
 	_, err := New(
 		"foo",
+		"community",
 		mock.Path("sheet/bad-fm"),
 		[]string{"alpha", "bravo"},
 		false,

internal/sheets/load.go

@@ -59,7 +59,13 @@ func Load(cheatpaths []cp.Cheatpath) ([]map[string]sheet.Sheet, error) {
 				}
 
 				// parse the cheatsheet file into a `sheet` struct
-				s, err := sheet.New(title, path, cheatpath.Tags, cheatpath.ReadOnly)
+				s, err := sheet.New(
+					title,
+					cheatpath.Name,
+					path,
+					cheatpath.Tags,
+					cheatpath.ReadOnly,
+				)
 				if err != nil {
 					return fmt.Errorf(
 						"failed to load sheet: %s, path: %s, err: %v",