some renaming, cleanup

Author: patrickdevivo

cmd/commands/todos.go

@@ -26,18 +26,18 @@ var todosCmd = &cobra.Command{
 			dir, err = filepath.Rel(cwd, args[0])
 			handleError(err)
 		}
+		found := make([]*todos.TODO, 0)
 		err = filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
 			if !info.IsDir() {
 				p, err := filepath.Rel(dir, path)
 				handleError(err)
-				_, err = todos.SearchFile(p)
+				t, err := todos.SearchFile(p)
 				handleError(err)
-				// if len(c) > 0 {
-				// 	fmt.Println(c)
-				// }
+				found = append(found, t...)
 			}
 			return nil
 		})
 		handleError(err)
+		todos.WriteTodos(found, os.Stdout)
 	},
 }

go.sum

@@ -11,8 +11,6 @@ github.com/apparentlymart/go-textseg v1.0.0/go.mod h1:z96Txxhf3xSFMPmb5X/1W05FF/
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
-github.com/augmentable-dev/lege v0.0.0-20191022024440-1583f8f6972a h1:CNfPUBMEyYvH1yJ/pGkLIisZ65y+EHStYPN72OIy9dk=
-github.com/augmentable-dev/lege v0.0.0-20191022024440-1583f8f6972a/go.mod h1:DtuvAW6+SE9e44O6eLaMJp8PFiadmk6NfXslCKYCiB0=
 github.com/augmentable-dev/lege v0.0.0-20191023021623-869a91bc405e h1:geKUZgzslZzV3VHxeMCwRhS4Zs/ocu2mTer4+dB3094=
 github.com/augmentable-dev/lege v0.0.0-20191023021623-869a91bc405e/go.mod h1:DtuvAW6+SE9e44O6eLaMJp8PFiadmk6NfXslCKYCiB0=
 github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=

pkg/todos/report.go

@@ -0,0 +1,29 @@
+package todos
+
+import (
+	"io"
+	"text/template"
+)
+
+// DefaultTemplate is the default report template
+const DefaultTemplate = `
+{{- range . }}
+=== 📋 {{ .String }}
+  --- {{ .FilePath }}:{{ .Line }}:{{ .Position }}
+{{- else }}
+no todos 🎉
+{{- end }}
+`
+
+// WriteTodos renders a report of todos
+func WriteTodos(todos []*TODO, writer io.Writer) error {
+
+	t, err := template.New("todos").Parse(DefaultTemplate)
+	if err != nil {
+		return err
+	}
+
+	t.Execute(writer, todos)
+
+	return nil
+}

pkg/todos/todos.go

@@ -2,7 +2,6 @@ package todos
 
 import (
 	"bytes"
-	"fmt"
 	"io/ioutil"
 	"path/filepath"
 	"strings"
@@ -13,12 +12,12 @@ import (
 
 // CStyleCommentOptions ...
 var CStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
-	BoundaryOptions: []lege.BoundaryOption{
-		lege.BoundaryOption{
+	Boundaries: []lege.Boundary{
+		lege.Boundary{
 			Starts: []string{"//"},
 			Ends:   []string{"\n"},
 		},
-		lege.BoundaryOption{
+		lege.Boundary{
 			Starts: []string{"/*"},
 			Ends:   []string{"*/"},
 		},
@@ -27,8 +26,8 @@ var CStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
 
 // HashStyleCommentOptions ...
 var HashStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
-	BoundaryOptions: []lege.BoundaryOption{
-		lege.BoundaryOption{
+	Boundaries: []lege.Boundary{
+		lege.Boundary{
 			Starts: []string{"#"},
 			Ends:   []string{"\n"},
 		},
@@ -51,8 +50,17 @@ var LanguageParseOptions map[Language]*lege.ParseOptions = map[Language]*lege.Pa
 	"PHP":        CStyleCommentOptions,
 }
 
-// SearchFile ...
-func SearchFile(filePath string) ([]*lege.Collection, error) {
+// ToDo represents a ToDo item
+type ToDo struct {
+	FilePath string
+	Line     int
+	Position int
+	String   string
+}
+
+// SearchFile searches a file for comments. It infers the language
+func SearchFile(filePath string) ([]*ToDo, error) {
+	todos := make([]*ToDo, 0)
 	src, err := ioutil.ReadFile(filePath)
 	if err != nil {
 		return nil, err
@@ -61,7 +69,10 @@ func SearchFile(filePath string) ([]*lege.Collection, error) {
 	if enry.IsVendor(filePath) {
 		return nil, nil
 	}
-	options := LanguageParseOptions[lang]
+	options, ok := LanguageParseOptions[lang]
+	if !ok {
+		return nil, nil
+	}
 	commentParser, err := lege.NewParser(options)
 	if err != nil {
 		return nil, err
@@ -78,8 +89,15 @@ func SearchFile(filePath string) ([]*lege.Collection, error) {
 		}
 		s = strings.Replace(comment.String(), "TODO", "", 1)
 		s = strings.Trim(s, " ")
-		fmt.Printf("%q\n", s)
+		// fmt.Printf("%q\n", s)
+		todo := &ToDo{
+			FilePath: filePath,
+			Line:     comment.StartLocation.Line,
+			Position: comment.StartLocation.Pos,
+			String:   s,
+		}
+		todos = append(todos, todo)
 	}
 
-	return comments, nil
+	return todos, nil
 }