more error improvement

Author: markbates

cmd_error.go

@@ -47,7 +47,7 @@ func (ce CmdError) Error() string {
 	}
 
 	if ce.Err != nil {
-		lines = append(lines, fmt.Sprintf("error: %s", ce.Err))
+		lines = append(lines, fmt.Sprintf("cmd error: %s", ce.Err))
 	}
 
 	sb.WriteString(strings.Join(lines, "\n"))

cmd_error_test.go

@@ -78,7 +78,7 @@ func Test_CmdError_Error(t *testing.T) {
 	act := ce.Error()
 	act = strings.TrimSpace(act)
 
-	exp := "filepath: /tmp/hype.md\ncmd: $ echo hello\nexit: 1\nerror: EOF"
+	exp := "filepath: /tmp/hype.md\ncmd: $ echo hello\nexit: 1\ncmd error: EOF"
 	exp = strings.TrimSpace(exp)
 
 	r.Equal(exp, act)

execute_error.go

@@ -44,7 +44,7 @@ func (pe ExecuteError) Error() string {
 	}
 
 	if pe.Err != nil {
-		lines = append(lines, fmt.Sprintf("error: %s", pe.Err))
+		lines = append(lines, fmt.Sprintf("execute error: %s", pe.Err))
 	}
 
 	sb.WriteString(strings.Join(lines, "\n"))

execute_error_test.go

@@ -146,12 +146,12 @@ func Test_ExecuteError_String(t *testing.T) {
 		{
 			name: "detailed",
 			in:   detailed,
-			exp:  "filepath: testdata/parser/errors/execute/hype.md\ndocument: My Title\nerror: EOF",
+			exp:  "filepath: testdata/parser/errors/execute/hype.md\ndocument: My Title\nexecute error: EOF",
 		},
 		{
 			name: "basic",
 			in:   ExecuteError{Err: io.EOF},
-			exp:  "error: EOF",
+			exp:  "execute error: EOF",
 		},
 	}
 

figure.go

@@ -47,7 +47,7 @@ func (f *Figure) MD() string {
 	bb := &strings.Builder{}
 	bb.WriteString(f.StartTag())
 	fmt.Fprintln(bb)
-	bb.WriteString(f.Nodes.MD())
+	bb.WriteString(f.Nodes.String())
 	bb.WriteString(f.EndTag())
 
 	return bb.String()

parse_error.go

@@ -38,7 +38,7 @@ func (pe ParseError) Error() string {
 	}
 
 	if pe.Err != nil {
-		lines = append(lines, fmt.Sprintf("error: %s", pe.Err))
+		lines = append(lines, fmt.Sprintf("parse error: %s", pe.Err))
 	}
 
 	sb.WriteString(strings.Join(lines, "\n"))

parse_error_test.go

@@ -64,7 +64,7 @@ func Test_ParseError_Error(t *testing.T) {
 
 	fmt.Println(act)
 
-	exp := "filepath: root/test.md\ncontents: contents\nerror: EOF"
+	exp := "filepath: root/test.md\nparse error: EOF"
 
 	r.Equal(exp, act)
 }

post_execute_error.go

@@ -3,6 +3,9 @@ package hype
 import (
 	"encoding/json"
 	"errors"
+	"fmt"
+	"path/filepath"
+	"strings"
 )
 
 type PostExecuteError struct {
@@ -29,7 +32,32 @@ func (pee PostExecuteError) MarshalJSON() ([]byte, error) {
 }
 
 func (e PostExecuteError) Error() string {
-	return toError(e)
+	sb := &strings.Builder{}
+
+	var lines []string
+
+	fp := filepath.Join(e.Root, e.Filename)
+	if len(fp) > 0 {
+		lines = append(lines, fmt.Sprintf("filepath: %s", fp))
+	}
+
+	if e.Document != nil && len(e.Document.Title) > 0 {
+		lines = append(lines, fmt.Sprintf("document: %s", e.Document.Title))
+	}
+
+	if e.Err != nil {
+		lines = append(lines, fmt.Sprintf("post execute error: %s", e.Err))
+	}
+
+	if e.OrigErr != nil {
+		lines = append(lines, fmt.Sprintf("original error: %s", e.OrigErr))
+	}
+
+	sb.WriteString(strings.Join(lines, "\n"))
+
+	s := sb.String()
+
+	return strings.TrimSpace(s)
 }
 
 func (e PostExecuteError) Unwrap() error {

post_parse_error.go

@@ -3,6 +3,9 @@ package hype
 import (
 	"encoding/json"
 	"errors"
+	"fmt"
+	"path/filepath"
+	"strings"
 )
 
 type PostParseError struct {
@@ -29,8 +32,32 @@ func (ppe PostParseError) MarshalJSON() ([]byte, error) {
 }
 
 func (ppe PostParseError) Error() string {
-	b, _ := ppe.MarshalJSON()
-	return string(b)
+	sb := &strings.Builder{}
+
+	var lines []string
+
+	fp := filepath.Join(ppe.Root, ppe.Filename)
+	if len(fp) > 0 {
+		lines = append(lines, fmt.Sprintf("filepath: %s", fp))
+	}
+
+	if ppe.Document != nil && len(ppe.Document.Title) > 0 {
+		lines = append(lines, fmt.Sprintf("document: %s", ppe.Document.Title))
+	}
+
+	if ppe.Err != nil {
+		lines = append(lines, fmt.Sprintf("post parse error: %s", ppe.Err))
+	}
+
+	if ppe.OrigErr != nil {
+		lines = append(lines, fmt.Sprintf("original error: %s", ppe.OrigErr))
+	}
+
+	sb.WriteString(strings.Join(lines, "\n"))
+
+	s := sb.String()
+
+	return strings.TrimSpace(s)
 }
 
 func (ppe PostParseError) Unwrap() error {

pre_execute_error.go

@@ -3,6 +3,9 @@ package hype
 import (
 	"encoding/json"
 	"errors"
+	"fmt"
+	"path/filepath"
+	"strings"
 )
 
 type PreExecuteError struct {
@@ -27,7 +30,28 @@ func (pee PreExecuteError) MarshalJSON() ([]byte, error) {
 }
 
 func (pee PreExecuteError) Error() string {
-	return toError(pee)
+	sb := &strings.Builder{}
+
+	var lines []string
+
+	fp := filepath.Join(pee.Root, pee.Filename)
+	if len(fp) > 0 {
+		lines = append(lines, fmt.Sprintf("filepath: %s", fp))
+	}
+
+	if pee.Document != nil && len(pee.Document.Title) > 0 {
+		lines = append(lines, fmt.Sprintf("document: %s", pee.Document.Title))
+	}
+
+	if pee.Err != nil {
+		lines = append(lines, fmt.Sprintf("pre execute error: %s", pee.Err))
+	}
+
+	sb.WriteString(strings.Join(lines, "\n"))
+
+	s := sb.String()
+
+	return strings.TrimSpace(s)
 }
 
 func (pee PreExecuteError) Unwrap() error {

pre_parse_error.go

@@ -40,11 +40,11 @@ func (e PreParseError) Error() string {
 	}
 
 	if e.PreParser != nil {
-		lines = append(lines, fmt.Sprintf("pre_parser: %s", toType(e.PreParser)))
+		lines = append(lines, fmt.Sprintf("pre parser: %s", toType(e.PreParser)))
 	}
 
 	if e.Err != nil {
-		lines = append(lines, fmt.Sprintf("error: %s", e.Err))
+		lines = append(lines, fmt.Sprintf("pre-parse error: %s", e.Err))
 	}
 
 	sb.WriteString(strings.Join(lines, "\n"))

pre_parse_error_test.go

@@ -145,7 +145,7 @@ func Test_PreParseError_Error(t *testing.T) {
 	act = strings.TrimSpace(act)
 
 	// fmt.Println(act)
-	exp := "filepath: root/hype.md\nerror: EOF"
+	exp := "filepath: root/hype.md\npre-parse error: EOF"
 
 	r.Equal(exp, act)
 }