Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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, todos []string) TodoMatcher
TodoMatcherForFile gets the correct todo matcher for the given filename
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package groovy contains a todo matcher & comments matcher for groovy comments.
|
Package groovy contains a todo matcher & comments matcher for groovy comments. |
|
Package php contains a todo matcher & comments matcher for PHP comments.
|
Package php contains a todo matcher & comments matcher for PHP comments. |
|
Package python contains a todo matcher & comments matcher for python comments.
|
Package python contains a todo matcher & comments matcher for python comments. |
|
Package scripts contains a todo matcher & comments matcher for scripts.
|
Package scripts contains a todo matcher & comments matcher for scripts. |
|
Package standard contains a todo matcher & comments matcher for standard C-like comments.
|
Package standard contains a todo matcher & comments matcher for standard C-like comments. |
|
Package vue contains a todo matcher & comments matcher for vue comments.
|
Package vue contains a todo matcher & comments matcher for vue comments. |
Click to show internal directories.
Click to hide internal directories.