Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New to do function #59

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

New to do function #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2be2042
started working on a check for .gitignore files
emmyhsohn Jun 12, 2020
474091f
added a new parameter to NewToDo
emmyhsohn Jun 15, 2020
05214a3
Merge branch 'master' into NewToDo-function
emmyhsohn Jun 15, 2020
4294ed9
Revert "started working on a check for .gitignore files"
emmyhsohn Jun 15, 2020
5caf797
update todos.go
emmyhsohn Jun 15, 2020
bf88ae7
update todos.go
emmyhsohn Jun 16, 2020
4f14b98
update todos.go again
emmyhsohn Jun 16, 2020
1f3d7dc
update NewToDo
emmyhsohn Jun 16, 2020
e0ebd28
fix redeclaration of startingMatchPhrases
emmyhsohn Jun 16, 2020
11bd4e2
add matchPhrases string[] as parameter
emmyhsohn Jun 24, 2020
0253090
fix typo
emmyhsohn Jun 24, 2020
adcd6a8
move startingMatchPhrases to todos_test.go
emmyhsohn Jun 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion cmd/tickgit/commands/todos.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
)

var csvOutput bool
var startingMatchPhrases []string = []string{"TODO", "FIXME", "OPTIMIZE", "HACK", "XXX", "WTF", "LEGACY"}

func init() {
todosCmd.Flags().BoolVar(&csvOutput, "csv-output", false, "specify whether or not output should be in CSV format")
Expand Down Expand Up @@ -47,7 +48,7 @@ var todosCmd = &cobra.Command{

foundToDos := make(todos.ToDos, 0)
err = comments.SearchDir(dir, func(comment *comments.Comment) {
todo := todos.NewToDo(*comment)
todo := todos.NewToDo(*comment, startingMatchPhrases)
if todo != nil {
foundToDos = append(foundToDos, todo)
s.Suffix = fmt.Sprintf(" %d TODOs found", len(foundToDos))
Expand Down
12 changes: 5 additions & 7 deletions pkg/todos/todos.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,10 @@ func (t *ToDo) TimeAgo() string {
}

// NewToDo produces a pointer to a ToDo from a comment
func NewToDo(comment comments.Comment) *ToDo {
func NewToDo(comment comments.Comment, matchPhrases []string) *ToDo {
// FIXME this should be configurable and probably NOT hardcoded here
// in fact, this list might be too expansive for a sensible default
startingMatchPhrases := []string{"TODO", "FIXME", "OPTIMIZE", "HACK", "XXX", "WTF", "LEGACY"}
var matchPhrases []string
for _, phrase := range startingMatchPhrases {
// in fact, this list might be too expansive for a sensible defaul
for _, phrase := range matchPhrases {
// populates matchPhrases with the contents of startingMatchPhrases plus the @+lowerCase version of each phrase
matchPhrases = append(matchPhrases, phrase, "@"+strings.ToLower(phrase))
}
Expand All @@ -55,10 +53,10 @@ func NewToDo(comment comments.Comment) *ToDo {
}

// NewToDos produces a list of ToDos from a list of comments
func NewToDos(comments comments.Comments) ToDos {
func NewToDos(comments comments.Comments, matchPhrases []string) ToDos {
todos := make(ToDos, 0)
for _, comment := range comments {
todo := NewToDo(*comment)
todo := NewToDo(*comment, matchPhrases)
if todo != nil {
todos = append(todos, todo)
}
Expand Down
6 changes: 4 additions & 2 deletions pkg/todos/todos_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ import (
"github.com/augmentable-dev/tickgit/pkg/comments"
)

var startingMatchPhrases []string = []string{"TODO", "FIXME", "OPTIMIZE", "HACK", "XXX", "WTF", "LEGACY"}

func TestNewToDoNil(t *testing.T) {
collection := lege.NewCollection(lege.Location{}, lege.Location{}, lege.Boundary{}, "Hello World")
comment := comments.Comment{
Collection: *collection,
}
todo := NewToDo(comment)
todo := NewToDo(comment, startingMatchPhrases)

if todo != nil {
t.Fatalf("did not expect a TODO, got: %v", todo)
Expand All @@ -24,7 +26,7 @@ func TestNewToDo(t *testing.T) {
comment := comments.Comment{
Collection: *collection,
}
todo := NewToDo(comment)
todo := NewToDo(comment, startingMatchPhrases)

if todo == nil {
t.Fatalf("expected a TODO, got: %v", todo)
Expand Down