Update nestif API to provide just pure message (#5)

Author: nakabonne

cmd/nestif/main.go

@@ -28,10 +28,15 @@ import (
 
 var (
 	flagSet = flag.NewFlagSet("nestif", flag.ContinueOnError)
-	usage   = func() {
+
+	usage = func() {
 		fmt.Fprintln(os.Stderr, "usage: nestif [<flag> ...] <Go files or directories or packages> ...")
 		flagSet.PrintDefaults()
 	}
+
+	errformat = func(file string, line, col int, msg string) string {
+		return fmt.Sprintf("%s:%d:%d: %s", file, line, col, msg)
+	}
 )
 
 type app struct {
@@ -234,7 +239,7 @@ func (a *app) write(issues []nestif.Issue) {
 		if i >= a.top {
 			return
 		}
-		fmt.Fprintln(a.stdout, issue.Message)
+		fmt.Fprintln(a.stdout, errformat(issue.Pos.Filename, issue.Pos.Line, issue.Pos.Column, issue.Message))
 	}
 }
 

cmd/nestif/main_test.go

@@ -31,23 +31,23 @@ func TestRun(t *testing.T) {
 			args:          []string{"../../testdata/a.go"},
 			minComplexity: 1,
 			top:           10,
-			want:          "../../testdata/a.go:9:2: `if b1` is nested (complexity: 1)\n",
+			want:          "../../testdata/a.go:9:2: `if b1` is deeply nested (complexity: 1)\n",
 			code:          0,
 		},
 		{
 			name:          "show only top 2",
 			args:          []string{"../../testdata/d.go"},
 			minComplexity: 1,
 			top:           2,
-			want:          "../../testdata/d.go:16:2: `if b1` is nested (complexity: 3)\n../../testdata/d.go:6:2: `if b1` is nested (complexity: 1)\n",
+			want:          "../../testdata/d.go:16:2: `if b1` is deeply nested (complexity: 3)\n../../testdata/d.go:6:2: `if b1` is deeply nested (complexity: 1)\n",
 			code:          0,
 		},
 		{
 			name:          "show only those with complexity of 2 or more",
 			args:          []string{"../../testdata/d.go"},
 			minComplexity: 2,
 			top:           10,
-			want:          "../../testdata/d.go:16:2: `if b1` is nested (complexity: 3)\n",
+			want:          "../../testdata/d.go:16:2: `if b1` is deeply nested (complexity: 3)\n",
 			code:          0,
 		},
 		{
@@ -63,15 +63,15 @@ func TestRun(t *testing.T) {
 			args:          []string{"../../testdata/a"},
 			minComplexity: 1,
 			top:           10,
-			want:          "../../testdata/a/a.go:8:2: `if b1` is nested (complexity: 1)\n",
+			want:          "../../testdata/a/a.go:8:2: `if b1` is deeply nested (complexity: 1)\n",
 			code:          0,
 		},
 		{
 			name:          "Check files recursively",
 			args:          []string{"../../testdata/a/..."},
 			minComplexity: 1,
 			top:           10,
-			want:          "../../testdata/a/a.go:8:2: `if b1` is nested (complexity: 1)\n../../testdata/a/b/a.go:8:2: `if b1` is nested (complexity: 1)\n",
+			want:          "../../testdata/a/a.go:8:2: `if b1` is deeply nested (complexity: 1)\n../../testdata/a/b/a.go:8:2: `if b1` is deeply nested (complexity: 1)\n",
 			code:          0,
 		},
 		{
@@ -99,7 +99,7 @@ func TestRun(t *testing.T) {
 			top:           10,
 			want: func() string {
 				path, _ := filepath.Abs("../../testdata/a/a.go")
-				return path + ":8:2: `if b1` is nested (complexity: 1)\n"
+				return path + ":8:2: `if b1` is deeply nested (complexity: 1)\n"
 			}(),
 			code: 0,
 		},
@@ -109,7 +109,7 @@ func TestRun(t *testing.T) {
 			args:          []string{"../../testdata/a.go"},
 			minComplexity: 1,
 			top:           10,
-			want:          "[{\"Pos\":{\"Filename\":\"../../testdata/a.go\",\"Offset\":78,\"Line\":9,\"Column\":2},\"Complexity\":1,\"Message\":\"../../testdata/a.go:9:2: `if b1` is nested (complexity: 1)\"}]\n",
+			want:          "[{\"Pos\":{\"Filename\":\"../../testdata/a.go\",\"Offset\":78,\"Line\":9,\"Column\":2},\"Complexity\":1,\"Message\":\"`if b1` is deeply nested (complexity: 1)\"}]\n",
 			code:          0,
 		},
 		{

nestif.go

@@ -74,7 +74,7 @@ func (c *Checker) checkIf(stmt *ast.IfStmt, fset *token.FileSet) {
 	c.issues = append(c.issues, Issue{
 		Pos:        pos,
 		Complexity: v.complexity,
-		Message:    c.makeMessage(pos.Filename, pos.Line, pos.Column, v.complexity, stmt.Cond, fset),
+		Message:    c.makeMessage(v.complexity, stmt.Cond, fset),
 	})
 }
 
@@ -127,18 +127,13 @@ func (v *visitor) incComplexity(n *ast.IfStmt) {
 	}
 }
 
-func (c *Checker) makeMessage(file string, line, col, complexity int, cond ast.Expr, fset *token.FileSet) string {
+func (c *Checker) makeMessage(complexity int, cond ast.Expr, fset *token.FileSet) string {
 	p := &printer.Config{}
 	b := new(bytes.Buffer)
 	if err := p.Fprint(b, fset, cond); err != nil {
 		c.debug("failed to convert condition into string: %v", err)
 	}
-	msg := fmt.Sprintf("`if %s` is nested (complexity: %d)", b.String(), complexity)
-	return errformat(file, line, col, msg)
-}
-
-func errformat(file string, line, col int, msg string) string {
-	return fmt.Sprintf("%s:%d:%d: %s", file, line, col, msg)
+	return fmt.Sprintf("`if %s` is deeply nested (complexity: %d)", b.String(), complexity)
 }
 
 // DebugMode makes it possible to emit debug logs.

nestif_test.go

@@ -36,7 +36,7 @@ func TestCheck(t *testing.T) {
 						Column:   2,
 					},
 					Complexity: 1,
-					Message:    "./testdata/a.go:9:2: `if b1` is nested (complexity: 1)",
+					Message:    "`if b1` is deeply nested (complexity: 1)",
 				},
 			},
 		},
@@ -53,7 +53,7 @@ func TestCheck(t *testing.T) {
 						Column:   2,
 					},
 					Complexity: 9,
-					Message:    "./testdata/b.go:5:2: `if b1` is nested (complexity: 9)",
+					Message:    "`if b1` is deeply nested (complexity: 9)",
 				},
 			},
 		},
@@ -70,7 +70,7 @@ func TestCheck(t *testing.T) {
 						Column:   2,
 					},
 					Complexity: 4,
-					Message:    "./testdata/c.go:6:2: `if b1` is nested (complexity: 4)",
+					Message:    "`if b1` is deeply nested (complexity: 4)",
 				},
 				{
 					Pos: token.Position{
@@ -80,7 +80,7 @@ func TestCheck(t *testing.T) {
 						Column:   2,
 					},
 					Complexity: 4,
-					Message:    "./testdata/c.go:14:2: `if b1` is nested (complexity: 4)",
+					Message:    "`if b1` is deeply nested (complexity: 4)",
 				},
 			},
 		},