todos

package

v0.0.0-...-0d20692 Latest Latest Go to latest Published: Mar 10, 2023 License: MIT Imports: 13 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

Repository

github.com/euforic/todos

Links

Open Source Insights

Documentation ¶

Index ¶

func ParseGitignore(dir string) ([]string, error)
func WriteFileGroup(w io.Writer, comments []Comment, sortby string, desc bool) error
func WriteJSON(w io.Writer, comments []Comment, sortby string, desc bool) error
func WriteMarkdown(w io.Writer, comments []Comment, sortby string, desc bool) error
func WriteTable(w io.Writer, comments []Comment, sortby string, desc bool) error
func WriteTemplate(w io.Writer, comments []Comment, sortby string, desc bool, sourceStr string) error
type Comment
- func Parse(r io.Reader, path string, commentTypes []string, permissive bool) ([]Comment, error)
- func Search(dir string, commentTypes []string, ignores []string, permissive bool) ([]Comment, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ParseGitignore ¶

func ParseGitignore(dir string) ([]string, error)

ParseGitignore parses the .gitignore file in the specified directory and returns a slice of patterns to ignore.

func WriteFileGroup ¶

func WriteFileGroup(w io.Writer, comments []Comment, sortby string, desc bool) error

WriteFileGroup writes the comments to the io.Writer as a file list

func WriteJSON ¶

func WriteJSON(w io.Writer, comments []Comment, sortby string, desc bool) error

WriteJSON writes the comments to the io.Writer as JSON

func WriteMarkdown ¶

func WriteMarkdown(w io.Writer, comments []Comment, sortby string, desc bool) error

WriteMarkdown writes the comments to the io.Writer as a markdown table

func WriteTable ¶

func WriteTable(w io.Writer, comments []Comment, sortby string, desc bool) error

WriteTable writes the comments to the io.Writer as a table

func WriteTemplate ¶

func WriteTemplate(w io.Writer, comments []Comment, sortby string, desc bool, sourceStr string) error

WriteTemplate writes the comments to the io.Writer using the given template

Types ¶

type Comment ¶

type Comment struct {
	File   string `json:"file"`
	Line   int    `json:"line"`
	Type   string `json:"type"`
	Text   string `json:"text"`
	Author string `json:"author"`
}

Comment represents a comment

func Parse ¶

func Parse(r io.Reader, path string, commentTypes []string, permissive bool) ([]Comment, error)

Parse parses the specified file and returns a slice of comments.

func Search ¶

func Search(dir string, commentTypes []string, ignores []string, permissive bool) ([]Comment, error)

Search searches a directory for comments

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL