Merge pull request #24 from gopherguides/better-errors

better errors and go 1.22

.github/workflows/tests.yml

@@ -6,30 +6,29 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        go-version: [1.21.x]
+        go-version: [1.22.x]
         os: [macos-latest, ubuntu-latest]
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Go
-      uses: actions/setup-go@v4
-      with:
-        go-version: "1.21.x"
+      - uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.22.x"
 
-    - name: Go Environment
-      run: go env
+      - name: Go Environment
+        run: go env
 
-    - name: Verify Go Modules
-      run: go mod verify
+      - name: Verify Go Modules
+        run: go mod verify
 
-    - name: Build
-      run: go build -v ./...
+      - name: Build
+        run: go build -v ./...
 
-    - name: Run tests with Race Detector
-      run: go test -race -vet=off ./...
+      - name: Run tests with Race Detector
+        run: go test -race -vet=off ./...
 
-    - name: Install staticcheck
-      run: go install honnef.co/go/tools/cmd/staticcheck@latest
-
-    - name: Run staticcheck
-      run: staticcheck ./...
+      - name: Install staticcheck
+        run: go install honnef.co/go/tools/cmd/staticcheck@latest
 
+      - name: Run staticcheck
+        run: staticcheck ./...

.gitignore

@@ -4,6 +4,7 @@ tmp
 *.pid
 coverage
 coverage.data
+coverage.out
 build/*
 *.pbxuser
 *.mode1v3

Makefile

@@ -3,6 +3,14 @@ default: test install hype
 test:
 	go test -timeout 10s -race -cover ./...
 
+cov:
+	go test -coverprofile=coverage.out ./...
+	go tool cover -html=coverage.out
+
+hypecov:
+	go test -coverprofile=coverage.out .
+	go tool cover -html=coverage.out
+
 install:
 	go install -v ./cmd/hype
 

binding/testdata/toc/01-one/simple/src/greet/go.mod

@@ -1,3 +1,3 @@
 module demo
 
-go 1.18
+go 1.22

binding/testdata/toc/01-one/src/greet/go.mod

@@ -1,3 +1,3 @@
 module demo
 
-go 1.18
+go 1.22

binding/testdata/toc/02-two/simple/src/greet/go.mod

@@ -1,3 +1,3 @@
 module demo
 
-go 1.18
+go 1.22

binding/testdata/toc/02-two/src/greet/go.mod

@@ -1,3 +1,3 @@
 module demo
 
-go 1.18
+go 1.22

binding/testdata/toc/03-three/simple/src/greet/go.mod

@@ -1,3 +1,3 @@
 module demo
 
-go 1.18
+go 1.22

binding/testdata/toc/03-three/src/greet/go.mod

@@ -1,3 +1,3 @@
 module demo
 
-go 1.18
+go 1.22

body.go

@@ -2,7 +2,6 @@ package hype
 
 import (
 	"encoding/json"
-	"fmt"
 )
 
 // Body is a container for all the elements in a document.
@@ -23,9 +22,9 @@ func (b *Body) MarshalJSON() ([]byte, error) {
 		return nil, err
 	}
 
-	m["type"] = fmt.Sprintf("%T", b)
+	m["type"] = toType(b)
 
-	return json.Marshal(m)
+	return json.MarshalIndent(m, "", "  ")
 }
 
 // AsPage returns the body as a Page.

body_test.go

@@ -17,5 +17,16 @@ func Test_Body_AsPage(t *testing.T) {
 	p := body.AsPage()
 	r.NotNil(p)
 	r.Equal(body.Element, p.Element)
+}
+
+func Test_Body_MarshalJSON(t *testing.T) {
+	t.Parallel()
+
+	body := &Body{
+		Element: NewEl("body", nil),
+	}
+
+	body.Nodes = append(body.Nodes, Text("hello"))
 
+	testJSON(t, "body", body)
 }

cmd.go

@@ -17,10 +17,10 @@ import (
 type Cmd struct {
 	*Element
 
-	Args         []string      `json:"args,omitempty"`
-	Env          []string      `json:"env,omitempty"`
-	ExpectedExit int           `json:"expected_exit,omitempty"`
-	Timeout      time.Duration `json:"timeout,omitempty"`
+	Args         []string
+	Env          []string
+	ExpectedExit int
+	Timeout      time.Duration
 
 	res *CmdResult
 }
@@ -38,7 +38,7 @@ func (c *Cmd) MarshalJSON() ([]byte, error) {
 		return nil, err
 	}
 
-	m["type"] = fmt.Sprintf("%T", c)
+	m["type"] = toType(c)
 	m["expected_exit"] = c.ExpectedExit
 	m["timeout"] = c.Timeout.String()
 
@@ -54,7 +54,7 @@ func (c *Cmd) MarshalJSON() ([]byte, error) {
 		m["result"] = c.res
 	}
 
-	return json.Marshal(m)
+	return json.MarshalIndent(m, "", "  ")
 }
 
 func (c *Cmd) MD() string {
@@ -109,18 +109,18 @@ func (c *Cmd) Execute(ctx context.Context, doc *Document) error {
 		switch c.ExpectedExit {
 		case -1:
 			if res.Exit == 0 {
-				return fmt.Errorf("unexpected exit code: %d: %w", res.Exit, err)
+				return c.newError(err)
 			}
 		default:
 			if res.Exit != c.ExpectedExit {
-				return fmt.Errorf("unexpected exit code: %d: %w", res.Exit, err)
+				return c.newError(err)
 			}
 		}
 	}
 
 	cres, err := NewCmdResult(doc.Parser, c, res)
 	if err != nil {
-		return err
+		return c.newError(err)
 	}
 
 	c.Lock()
@@ -131,6 +131,27 @@ func (c *Cmd) Execute(ctx context.Context, doc *Document) error {
 	return nil
 }
 
+func (c *Cmd) newError(err error) error {
+	if c == nil {
+		return err
+	}
+
+	re, ok := err.(clam.RunError)
+	if !ok {
+		return CmdError{
+			RunError: clam.RunError{
+				Err: err,
+			},
+			Filename: c.Filename,
+		}
+	}
+
+	return CmdError{
+		RunError: re,
+		Filename: c.Filename,
+	}
+}
+
 func NewCmd(el *Element) (*Cmd, error) {
 	if el == nil {
 		return nil, ErrIsNil("element")

cmd/hype/cli/encode_test.go

@@ -95,7 +95,11 @@ func Test_Encode_JSON(t *testing.T) {
 			act := bb.Out.String()
 			act = strings.TrimSpace(act)
 
-			// fmt.Println(act)
+			// fp := filepath.Join(root, tc.exp)
+			// f, err := os.Create(fp)
+			// r.NoError(err)
+			// f.Write([]byte(act))
+			// r.NoError(f.Close())
 
 			r.Equal(exp, act)