errors

Documentation

Index

• type TODO
  • func IssueClosedErr(filename string, lines []string, linecnt int, issueID string) *TODO
  • func IssueNonExistentErr(filename string, lines []string, linecnt int, issueID string) *TODO
  • func MalformedTODOErr(filename string, lines []string, linecnt int) *TODO
  • func (err *TODO) Error() string
  • func (err *TODO) String() string
  • func (err *TODO) ToJSON() ([]byte, error)
• type TODOErrType

Types

type TODO

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

TODO encapsulates the todo error information

func IssueClosedErr

func IssueClosedErr(filename string, lines []string, linecnt int, issueID string) *TODO

IssueClosedErr when referenced todo issue is closed

func IssueNonExistentErr

func IssueNonExistentErr(filename string, lines []string, linecnt int, issueID string) *TODO

IssueNonExistentErr when referenced todo issue doesn't exist

func MalformedTODOErr

func MalformedTODOErr(filename string, lines []string, linecnt int) *TODO

MalformedTODOErr when todo is not properly formatted

func (*TODO) Error

func (err *TODO) Error() string

func (*TODO) String

func (err *TODO) String() string

func (*TODO) ToJSON

func (err *TODO) ToJSON() ([]byte, error)

ToJSON converts the todo error into json format

type TODOErrType

type TODOErrType string

TODOErrType is an enum representing the type of todo error

const (
	TODOErrTypeMalformed        TODOErrType = "Malformed todo"
	TODOErrTypeIssueClosed      TODOErrType = "Issue is closed"
	TODOErrTypeNonExistentIssue TODOErrType = "Issue doesn't exist"
)

supported todo error types enum