directive

Documentation

Overview

Package directive parses directive comments from ast or dst.

Index

• Constants
• func EnumerateCommentGroup(comments *ast.CommentGroup) iter.Seq[string]
• func ExcludeIgnoredGenDecl(genDecl *ast.GenDecl) (bool, error)
• func ExcludeIgnoredTypeSpec(ts *ast.TypeSpec, _ types.Object) (bool, error)
• func ParseFieldDirectiveCommentDst[T any](prefix string, comments dst.FieldDecorations, ...) (T, bool, error)
• type Direction
  • func ParseDirectiveComment(comments *ast.CommentGroup) (Direction, bool, error)
  • func ParseDirectiveCommentDst(comments dst.NodeDecs) (Direction, bool, error)
  • func (d Direction) IsGenerated() bool
  • func (d Direction) MustIgnore() bool

Constants

const (
	DirectiveCommentIgnore    = "ignore"
	DirectiveCommentGenerated = "generated"
)

const (
	DirectivePrefix = "codegen:"
)

Functions

func EnumerateCommentGroup

func EnumerateCommentGroup(comments *ast.CommentGroup) iter.Seq[string]

func ExcludeIgnoredGenDecl

func ExcludeIgnoredGenDecl(genDecl *ast.GenDecl) (bool, error)

func ExcludeIgnoredTypeSpec

func ExcludeIgnoredTypeSpec(ts *ast.TypeSpec, _ types.Object) (bool, error)

func ParseFieldDirectiveCommentDst

func ParseFieldDirectiveCommentDst[T any](
	prefix string,
	comments dst.FieldDecorations,
	parser func(s []string) (T, error),
) (T, bool, error)

Types

type Direction

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

func ParseDirectiveComment

func ParseDirectiveComment(comments *ast.CommentGroup) (Direction, bool, error)

func ParseDirectiveCommentDst

func ParseDirectiveCommentDst(comments dst.NodeDecs) (Direction, bool, error)

func (Direction) IsGenerated

func (d Direction) IsGenerated() bool

func (Direction) MustIgnore

func (d Direction) MustIgnore() bool