Friendlier output for IDEs

Author: Jonathan Gautheron

cmd/goconst/main.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"strings"
 
 	"github.com/jgautheron/goconst"
 )
@@ -91,11 +92,18 @@ func printOutput(strs goconst.Strings, consts goconst.Constants, output string,
 		})
 	case "text":
 		for str, item := range strs {
-			fmt.Printf(`%d occurrences of "%s" found:`, len(item), str)
 			for _, xpos := range item {
-				fmt.Printf("\n\t%s", xpos.String())
+				fmt.Printf(
+					`%s:%d:%d:%d other occurrence(s) of "%s" found in: %s`,
+					xpos.Filename,
+					xpos.Line,
+					xpos.Column,
+					len(item)-1,
+					str,
+					occurrences(item, xpos),
+				)
+				fmt.Print("\n")
 			}
-			fmt.Print("\n")
 
 			if len(consts) == 0 {
 				continue
@@ -110,3 +118,16 @@ func printOutput(strs goconst.Strings, consts goconst.Constants, output string,
 		fmt.Printf(`Unsupported output format: %s`, output)
 	}
 }
+
+func occurrences(item []goconst.ExtendedPos, current goconst.ExtendedPos) string {
+	occurrences := []string{}
+	for _, xpos := range item {
+		if xpos == current {
+			continue
+		}
+		occurrences = append(occurrences, fmt.Sprintf(
+			"%s:%d:%d", xpos.Filename, xpos.Line, xpos.Column,
+		))
+	}
+	return strings.Join(occurrences, " ")
+}

parser.go

@@ -1,3 +1,9 @@
+// Package goconst finds repeated strings that could be replaced by a constant.
+//
+// There are obvious benefits to using constants instead of repeating strings,
+// mostly to ease maintenance. Cannot argue against changing a single constant versus many strings.
+// While this could be considered a beginner mistake, across time,
+// multiple packages and large codebases, some repetition could have slipped in.
 package goconst
 
 import (
@@ -25,6 +31,8 @@ type Parser struct {
 	consts Constants
 }
 
+// New creates a new instance of the parser.
+// This is your entry point if you'd like to use goconst as an API.
 func New(path, ignore string, ignoreTests, matchConstant bool) *Parser {
 	return &Parser{
 		path:          path,
@@ -38,6 +46,8 @@ func New(path, ignore string, ignoreTests, matchConstant bool) *Parser {
 	}
 }
 
+// ParseTree will search the given path for occurrences that could be moved into constants.
+// If "..." is appended, the search will be recursive.
 func (p *Parser) ParseTree() (Strings, Constants, error) {
 	pathLen := len(p.path)
 	// Parse recursively the given path if the recursive notation is found