matchers

Documentation

Index

• func SupportedFileExtensions() []string
• type CommentMatcher
  • func CommentMatcherForFile(filename string, callback state.CommentCallback) CommentMatcher
• type TodoMatcher
  • func TodoMatcherForFile(filename string) TodoMatcher

Functions

func SupportedFileExtensions

func SupportedFileExtensions() []string

SupportedFileExtensions for which there is a todo matcher

Types

type CommentMatcher

type CommentMatcher interface {
	NonCommentState(filename, line string, linecnt int, prevToken, currToken, nextToken rune) (state.CommentState, error)
	StringState(filename, line string, linecnt int, prevToken, currToken, nextToken rune) (state.CommentState, error)
	SingleLineCommentState(filename, line string, linecnt int, prevToken, currToken, nextToken rune) (state.CommentState, error)
	MultiLineCommentState(filename, line string, linecnt int, prevToken, currToken, nextToken rune) (state.CommentState, error)
}

CommentMatcher is used to match comments for various filetypes & comment-types. It is meant to be used by a file traversal state-machine

func CommentMatcherForFile

func CommentMatcherForFile(filename string, callback state.CommentCallback) CommentMatcher

CommentMatcherForFile gets the correct comment matcher for the given filename

type TodoMatcher

type TodoMatcher interface {
	IsMatch(expr string) bool
	IsValid(expr string) bool
	ExtractIssueRef(expr string) (string, error)
}

TodoMatcher for todo comments

func TodoMatcherForFile

func TodoMatcherForFile(filename string) TodoMatcher

TodoMatcherForFile gets the correct todo matcher for the given filename