Add the possibility to search also for numbers; fixes #1

Author: Jonathan Gautheron

README.md

@@ -26,6 +26,7 @@ Flags:
   -ignore-tests      exclude tests from the search (default: true)
   -min-occurrences   report from how many occurrences (default: 2)
   -match-constant    look for existing constants matching the strings
+  -numbers           search also for duplicated numbers
   -output            output formatting (text or json)
 
 Examples:

cmd/goconst/main.go

@@ -23,6 +23,7 @@ Flags:
   -ignore-tests      exclude tests from the search (default: true)
   -min-occurrences   report from how many occurrences (default: 2)
   -match-constant    look for existing constants matching the strings
+  -numbers           search also for duplicated numbers
   -output            output formatting (text or json)
 
 Examples:
@@ -37,6 +38,7 @@ var (
 	flagIgnoreTests    = flag.Bool("ignore-tests", true, "exclude tests from the search")
 	flagMinOccurrences = flag.Int("min-occurrences", 2, "report from how many occurrences")
 	flagMatchConstant  = flag.Bool("match-constant", false, "look for existing constants matching the strings")
+	flagNumbers        = flag.Bool("numbers", false, "search also for duplicated numbers")
 	flagOutput         = flag.String("output", "text", "output formatting")
 )
 
@@ -58,6 +60,7 @@ func main() {
 		*flagIgnore,
 		*flagIgnoreTests,
 		*flagMatchConstant,
+		*flagNumbers,
 	)
 	strs, consts, err := gco.ParseTree()
 	if err != nil {
@@ -84,12 +87,15 @@ func printOutput(strs goconst.Strings, consts goconst.Constants, output string,
 	switch output {
 	case "json":
 		enc := json.NewEncoder(os.Stdout)
-		enc.Encode(struct {
+		err := enc.Encode(struct {
 			Strings   goconst.Strings   `json:"strings,omitEmpty"`
 			Constants goconst.Constants `json:"constants,omitEmpty"`
 		}{
 			strs, consts,
 		})
+		if err != nil {
+			log.Fatal(err)
+		}
 	case "text":
 		for str, item := range strs {
 			for _, xpos := range item {

parser.go

@@ -26,19 +26,27 @@ type Parser struct {
 	path, ignore               string
 	ignoreTests, matchConstant bool
 
+	supportedTokens []token.Token
+
 	// Internals
 	strs   Strings
 	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 {
+func New(path, ignore string, ignoreTests, matchConstant, numbers bool) *Parser {
+	supportedTokens := []token.Token{token.STRING}
+	if numbers {
+		supportedTokens = append(supportedTokens, token.INT, token.FLOAT)
+	}
+
 	return &Parser{
-		path:          path,
-		ignore:        ignore,
-		ignoreTests:   ignoreTests,
-		matchConstant: matchConstant,
+		path:            path,
+		ignore:          ignore,
+		ignoreTests:     ignoreTests,
+		matchConstant:   matchConstant,
+		supportedTokens: supportedTokens,
 
 		// Initialize the maps
 		strs:   Strings{},

visitor.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 )
 
-// TreeVisitor carries the package name and file name
+// treeVisitor carries the package name and file name
 // for passing it to the imports map, and the fileSet for
 // retrieving the token.Position.
 type treeVisitor struct {
@@ -40,19 +40,19 @@ func (v *treeVisitor) Visit(node ast.Node) ast.Visitor {
 			val := spec.(*ast.ValueSpec)
 			for i, str := range val.Values {
 				lit, ok := str.(*ast.BasicLit)
-				if !ok || lit.Kind != token.STRING {
+				if !ok || !v.isSupported(lit.Kind) {
 					continue
 				}
 
 				v.addConst(val.Names[i].Name, lit.Value, val.Names[i].Pos())
 			}
 		}
 
-		// foo := "moo"
+	// foo := "moo"
 	case *ast.AssignStmt:
 		for _, rhs := range t.Rhs {
 			lit, ok := rhs.(*ast.BasicLit)
-			if !ok || lit.Kind != token.STRING {
+			if !ok || !v.isSupported(lit.Kind) {
 				continue
 			}
 
@@ -69,20 +69,20 @@ func (v *treeVisitor) Visit(node ast.Node) ast.Visitor {
 		var ok bool
 
 		lit, ok = t.X.(*ast.BasicLit)
-		if ok && lit.Kind == token.STRING {
+		if ok && v.isSupported(lit.Kind) {
 			v.addString(lit.Value, lit.Pos())
 		}
 
 		lit, ok = t.Y.(*ast.BasicLit)
-		if ok && lit.Kind == token.STRING {
+		if ok && v.isSupported(lit.Kind) {
 			v.addString(lit.Value, lit.Pos())
 		}
 
 	// case "foo":
 	case *ast.CaseClause:
 		for _, item := range t.List {
 			lit, ok := item.(*ast.BasicLit)
-			if ok && lit.Kind == token.STRING {
+			if ok && v.isSupported(lit.Kind) {
 				v.addString(lit.Value, lit.Pos())
 			}
 		}
@@ -91,7 +91,7 @@ func (v *treeVisitor) Visit(node ast.Node) ast.Visitor {
 	case *ast.ReturnStmt:
 		for _, item := range t.Results {
 			lit, ok := item.(*ast.BasicLit)
-			if ok && lit.Kind == token.STRING {
+			if ok && v.isSupported(lit.Kind) {
 				v.addString(lit.Value, lit.Pos())
 			}
 		}
@@ -128,3 +128,12 @@ func (v *treeVisitor) addConst(name string, val string, pos token.Pos) {
 		Position:    v.fileSet.Position(pos),
 	}
 }
+
+func (v *treeVisitor) isSupported(tk token.Token) bool {
+	for _, s := range v.p.supportedTokens {
+		if tk == s {
+			return true
+		}
+	}
+	return false
+}