ast

Documentation

Index

• func FileToCoverageItems(logger hclog.Logger, file string) ([]*proto.CoverageItem, error)
• func IsHeader(fset *token.FileSet, cg *ast.CommentGroup, b *proto.Block) bool
• func IsInline(fset *token.FileSet, cg *ast.CommentGroup, b *proto.Block) bool
• func IsOnlyNoLintAnnotation(str string) bool
• func Normalize(str string) string
• func ProcessFileCoverage(file string, fset *token.FileSet, f *ast.File) []*proto.CoverageItem
• func ProcessFunctionCoverage(file string, fset *token.FileSet, f *ast.File, fdecl *ast.FuncDecl) *proto.CoverageItem
• func ProcessPackageCoverage(file string, fset *token.FileSet, f *ast.File) *proto.CoverageItem
• func ProcessTypeCoverage(file string, fset *token.FileSet, f *ast.File, gdecl *ast.GenDecl) []*proto.CoverageItem
• func ProcessVariableCoverage(file string, fset *token.FileSet, f *ast.File, gdecl *ast.GenDecl) []*proto.CoverageItem

Functions

func FileToCoverageItems

func FileToCoverageItems(logger hclog.Logger, file string) ([]*proto.CoverageItem, error)

FileToCoverageItems is the logic of the plugin. it converts file to CoverageItems.

func IsHeader

func IsHeader(fset *token.FileSet, cg *ast.CommentGroup, b *proto.Block) bool

IsHeader returns true if the given *ast.CommentGroup is belonged to the given *proto.Block as HeaderComments.

func IsInline

func IsInline(fset *token.FileSet, cg *ast.CommentGroup, b *proto.Block) bool

IsInline returns true if the given *ast.CommentGroup is belonged to the given *proto.Block as InlineComments.

func IsOnlyNoLintAnnotation

func IsOnlyNoLintAnnotation(str string) bool

func Normalize

func Normalize(str string) string

Normalize the given comment text.

func ProcessFileCoverage

func ProcessFileCoverage(file string, fset *token.FileSet, f *ast.File) []*proto.CoverageItem

ProcessFileCoverage measures the comment coverage for the entire given file.

func ProcessFunctionCoverage

func ProcessFunctionCoverage(file string, fset *token.FileSet, f *ast.File, fdecl *ast.FuncDecl) *proto.CoverageItem

ProcessFunctionCoverage measures the comment coverage of functions.

func ProcessPackageCoverage

func ProcessPackageCoverage(file string, fset *token.FileSet, f *ast.File) *proto.CoverageItem

ProcessPackageCoverage measures the package level comment coverage.

func ProcessTypeCoverage

func ProcessTypeCoverage(file string, fset *token.FileSet, f *ast.File, gdecl *ast.GenDecl) []*proto.CoverageItem

ProcessTypeCoverage measures the comment coverage of type declarations.

func ProcessVariableCoverage

func ProcessVariableCoverage(file string, fset *token.FileSet, f *ast.File, gdecl *ast.GenDecl) []*proto.CoverageItem

ProcessVariableCoverage measures the comment coverage of variables.