From bddbee4158bef06918e713d965bd962467bde426 Mon Sep 17 00:00:00 2001
From: Chris Lane <chris@chris-allen-lane.com>
Date: Wed, 11 Mar 2020 18:51:06 -0400
Subject: [PATCH 1/3] fix(logging): improve sheets load logging

Improve logging in `sheets.Load`:

- Make error verbage consistant with verbiage elsewhere

- Add more information to logging statements
---
 internal/sheets/load.go | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/internal/sheets/load.go b/internal/sheets/load.go
index 1ad7877..9ea85fb 100644
--- a/internal/sheets/load.go
+++ b/internal/sheets/load.go
@@ -33,7 +33,7 @@ func Load(cheatpaths []cp.Cheatpath) ([]map[string]sheet.Sheet, error) {
 
 				// fail if an error occurred while walking the directory
 				if err != nil {
-					return fmt.Errorf("error walking path: %v", err)
+					return fmt.Errorf("failed to walk path: %v", err)
 				}
 
 				// don't register directories as cheatsheets
@@ -61,7 +61,12 @@ 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)
 				if err != nil {
-					return fmt.Errorf("could not create sheet: %v", err)
+					return fmt.Errorf(
+						"failed to load sheet: %s, path: %s, err: %v",
+						title,
+						path,
+						err,
+					)
 				}
 
 				// register the cheatsheet on its cheatpath, keyed by its title

From 5288bd0c1c241734023b0811a99da7789f350c85 Mon Sep 17 00:00:00 2001
From: Chris Lane <chris@chris-allen-lane.com>
Date: Wed, 11 Mar 2020 18:54:46 -0400
Subject: [PATCH 2/3] fix(frontmatter): resolve issue #544

- Fix error in `frontmatter.Parse` which would cause a `panic` when
  encountering malformed frontmatter

- Add a unit-test to cover the above
---
 internal/frontmatter/frontmatter.go      | 14 ++++++++++++--
 internal/frontmatter/frontmatter_test.go | 24 ++++++++++++++++++++++++
 2 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/internal/frontmatter/frontmatter.go b/internal/frontmatter/frontmatter.go
index b3e7813..1ad3625 100644
--- a/internal/frontmatter/frontmatter.go
+++ b/internal/frontmatter/frontmatter.go
@@ -1,6 +1,7 @@
 package frontmatter
 
 import (
+	"fmt"
 	"strings"
 
 	"gopkg.in/yaml.v1"
@@ -28,7 +29,16 @@ func Parse(markdown string) (string, Frontmatter, error) {
 
 	// otherwise, split the frontmatter and cheatsheet text
 	parts := strings.SplitN(markdown, delim, 3)
-	err := yaml.Unmarshal([]byte(parts[1]), &fm)
 
-	return strings.TrimSpace(parts[2]), fm, err
+	// return an error if the frontmatter parses into the wrong number of parts
+	if len(parts) != 3 {
+		return markdown, fm, fmt.Errorf("failed to delimit frontmatter")
+	}
+
+	// return an error if the YAML cannot be unmarshalled
+	if err := yaml.Unmarshal([]byte(parts[1]), &fm); err != nil {
+		return markdown, fm, fmt.Errorf("failed to unmarshal frontmatter: %v", err)
+	}
+
+	return strings.TrimSpace(parts[2]), fm, nil
 }
diff --git a/internal/frontmatter/frontmatter_test.go b/internal/frontmatter/frontmatter_test.go
index d6c8e32..4a0159a 100644
--- a/internal/frontmatter/frontmatter_test.go
+++ b/internal/frontmatter/frontmatter_test.go
@@ -69,3 +69,27 @@ func TestHasNoFrontmatter(t *testing.T) {
 		t.Errorf("failed to parse tags: want: len 0, got: len %d", len(fm.Tags))
 	}
 }
+
+// TestHasInvalidFrontmatter asserts that markdown is properly parsed when it
+// contains invalid frontmatter
+func TestHasInvalidFrontmatter(t *testing.T) {
+
+	// stub our cheatsheet content (with invalid frontmatter)
+	markdown := `---
+syntax: go
+tags: [ test ]
+To foo the bar: baz`
+
+	// parse the frontmatter
+	text, _, err := Parse(markdown)
+
+	// assert that an error was returned
+	if err == nil {
+		t.Error("failed to error on invalid frontmatter")
+	}
+
+	// assert that the "raw" markdown was returned
+	if text != markdown {
+		t.Errorf("failed to parse text: want: %s, got: %s", markdown, text)
+	}
+}

From b15ff10537501f280d698b8df7f2e1ba5ee25090 Mon Sep 17 00:00:00 2001
From: Chris Lane <chris@chris-allen-lane.com>
Date: Wed, 11 Mar 2020 18:55:59 -0400
Subject: [PATCH 3/3] chore(version): bump version to 3.7.1

---
 cmd/cheat/main.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/cmd/cheat/main.go b/cmd/cheat/main.go
index f27dfcb..77fc06f 100755
--- a/cmd/cheat/main.go
+++ b/cmd/cheat/main.go
@@ -17,7 +17,7 @@ import (
 	"github.com/cheat/cheat/internal/installer"
 )
 
-const version = "3.7.0"
+const version = "3.7.1"
 
 func main() {