comments

Documentation

Index

• Variables
• type Comment
• type Comments
  • func SearchCommit(commit *object.Commit) (Comments, error)
  • func SearchDir(dirPath string) (Comments, error)
  • func SearchFile(filePath string, reader io.ReadCloser) (Comments, error)
• type Language

Variables

var CStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
	Boundaries: []lege.Boundary{
		lege.Boundary{
			Start: "//",
			End:   "\n",
		},
		lege.Boundary{
			Start: "/*",
			End:   "*/",
		},
	},
}

CStyleCommentOptions ...

var HashStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
	Boundaries: []lege.Boundary{
		lege.Boundary{
			Start: "#",
			End:   "\n",
		},
	},
}

HashStyleCommentOptions ...

var LanguageParseOptions map[Language]*lege.ParseOptions = map[Language]*lege.ParseOptions{
	"Go":           CStyleCommentOptions,
	"Java":         CStyleCommentOptions,
	"C":            CStyleCommentOptions,
	"C++":          CStyleCommentOptions,
	"C#":           CStyleCommentOptions,
	"JavaScript":   CStyleCommentOptions,
	"Python":       HashStyleCommentOptions,
	"Ruby":         HashStyleCommentOptions,
	"PHP":          CStyleCommentOptions,
	"Shell":        HashStyleCommentOptions,
	"Visual Basic": &lege.ParseOptions{Boundaries: []lege.Boundary{lege.Boundary{Start: "'", End: "\n"}}},
	"TypeScript":   CStyleCommentOptions,
	"Objective-C":  CStyleCommentOptions,
	"Groovy":       CStyleCommentOptions,
	"Swift":        CStyleCommentOptions,
}

LanguageParseOptions keeps track of source languages and their corresponding comment options

Types

type Comment

type Comment struct {
	lege.Collection
	FilePath string
}

Comment represents a comment in a source code file

type Comments

type Comments []*Comment

Comments is a list of comments

func SearchCommit

func SearchCommit(commit *object.Commit) (Comments, error)

SearchCommit searches all files in the tree of a given commit

func SearchDir

func SearchDir(dirPath string) (Comments, error)

SearchDir searches a directory for comments

func SearchFile

func SearchFile(filePath string, reader io.ReadCloser) (Comments, error)

SearchFile searches a file for comments. It infers the language

type Language

type Language string

Language is a source language (i.e. "Go")