writer

package

v0.0.0-...-df6f3e2 Latest Latest Go to latest Published: Jul 14, 2022 License: MIT Imports: 6 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.

This section is empty.

type Todo struct {
	File       string
	Line       int
	Message    string
	ByteOffset int
}

type TodoWriter struct {
	// contains filtered or unexported fields
}

func NewTodoWriter(target string, depth int, relativePaths bool, ignoredFiles []string, ignoredDirs []string) *TodoWriter

func (td *TodoWriter) GetList() []Todo

Returns the writers current item list

func (td *TodoWriter) PrintList()

Prints the formatted list

func (td *TodoWriter) PrintRaw()

Prints raw todos without any formatting

func (td *TodoWriter) Read(dirname string) error

Reads the given directory for todos and adds them to the writers list. The writer list is not cleared before reading.