todos

package

v0.0.14 Latest Latest Go to latest Published: Jun 12, 2020 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func WriteTodos(todos ToDos, writer io.Writer) error

WriteTodos renders a report of todos

type ToDo struct {
	comments.Comment
	String string
	Phrase string
	Blame  *blame.Blame
}

ToDo represents a ToDo item

func NewToDo(comment comments.Comment) *ToDo

NewToDo produces a pointer to a ToDo from a comment

func (t *ToDo) TimeAgo() string

TimeAgo returns a human readable string indicating the time since the todo was added

type ToDos []*ToDo

ToDos represents a list of ToDo items

func NewToDos(comments comments.Comments) ToDos

NewToDos produces a list of ToDos from a list of comments

func (t ToDos) CountWithCommits() (count int)

CountWithCommits returns the number of todos with an associated commit (in which that todo was added)

func (t *ToDos) FindBlame(ctx context.Context, dir string) error

FindBlame sets the blame information on each todo in a set of todos

func (t ToDos) Len() int

Len returns the number of todos

func (t ToDos) Less(i, j int) bool

Less compares two todos by their creation time

func (t ToDos) Swap(i, j int)

Swap swaps two todos