comment

Documentation

Index

• func HasDirective(comments []*ast.CommentGroup, expected Directive) bool
• type Cache
  • func (c *Cache) Get(fset *token.FileSet, f *ast.File) ast.CommentMap
• type Directive

Functions

func HasDirective

func HasDirective(comments []*ast.CommentGroup, expected Directive) bool

HasDirective parses a directive from a given list of comments. If no directive is found, the second return value is `false`.

Types

type Cache

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

func (*Cache) Get

func (c *Cache) Get(fset *token.FileSet, f *ast.File) ast.CommentMap

Get returns a comment map for a given file. In case if a comment map is not found, it creates a new one.

type Directive

type Directive string

const (
	DirectiveIgnore  Directive = prefix + `ignore`
	DirectiveEnforce Directive = prefix + `enforce`
)