parser

Documentation

Index

• func ExampleDeprecationNote()
• func GetPackages() ([]string, error)
• type DescriptionData
• type EntityExtractor
• type EntityInfo
  • func ParseEntitiesInPackage(pkgPath string) ([]EntityInfo, error)
• type FieldInfo
• type FunctionExtractor
  • func (f FunctionExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, ...) EntityInfo
• type ImplementationInfo
• type InterfaceExtractor
  • func (i InterfaceExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, ...) EntityInfo
• type MethodInfo
• type StructExtractor
  • func (s StructExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, ...) EntityInfo
• type TypeExtractor
  • func (t TypeExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, ...) EntityInfo

Functions

func ExampleDeprecationNote

func ExampleDeprecationNote()

ExampleDeprecationNote is an example of a deprecated function

Deprecated: This function is deprecated only for demonstration purposes

func GetPackages

func GetPackages() ([]string, error)

GetPackages returns a list of all package directories in the project

Example:

packages, err := parser.GetPackages()
if err != nil {
	log.Fatalf("Error fetching packages: %v", err)
}
for _, pkg := range packages {
	fmt.Printf("Package: %s\n", pkg)
}

Types

type DescriptionData

type DescriptionData struct {
	Description     string
	Example         string
	Notes           string
	DeprecationNote string

	// Raw fields
	DescriptionRaw     string
	DeprecationNoteRaw string
}

DescriptionData contains different parts of a function's documentation comment

type EntityExtractor

type EntityExtractor interface {
	Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, pkgName string) EntityInfo
}

EntityExtractor defines an interface for extracting information from AST declarations

type EntityInfo

type EntityInfo struct {
	Name            string
	Description     string
	Example         string
	Notes           string
	DeprecationNote string
	Parameters      []string
	Returns         []string
	Body            string
	Type            string
	Fields          []FieldInfo
	Methods         []MethodInfo
	Implements      []ImplementationInfo
	Package         string

	// Raw fields
	DescriptionRaw     string
	DeprecationNoteRaw string
}

EntityInfo contains relevant information about each entity in the package (functions, types, interfaces)

func ParseEntitiesInPackage

func ParseEntitiesInPackage(pkgPath string) ([]EntityInfo, error)

ParseEntitiesInPackage parses the entities in a given package and returns a slice of EntityInfo

Example:

entities, err := parser.ParseEntitiesInPackage("github.com/gophercises/quiz")
if err != nil {
	log.Fatalf("Error parsing entities: %v", err)
}
for _, entity := range entities {
	fmt.Printf("Name: %s\n", entity.Name)
	fmt.Printf("Type: %s\n", entity.Type)
	fmt.Printf("Description: %s\n", entity.Description)
	fmt.Printf("Package: %s\n", entity.Package)
}

Notes: The package must be a full path to the package directory

type FieldInfo

type FieldInfo struct {
	Name string
	Type string
	Tag  string
}

FieldInfo contains relevant information about each field in a struct

type FunctionExtractor

type FunctionExtractor struct{}

FunctionExtractor extracts information from function declarations

func (FunctionExtractor) Extract

func (f FunctionExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, pkgName string) EntityInfo

type ImplementationInfo

type ImplementationInfo struct {
	InterfaceName string
	Package       string
}

ImplementationInfo contains information about an implemented interface

type InterfaceExtractor

type InterfaceExtractor struct{}

InterfaceExtractor extracts information from interface declarations

func (InterfaceExtractor) Extract

func (i InterfaceExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, pkgName string) EntityInfo

type MethodInfo

type MethodInfo struct {
	Name       string
	Parameters []string
	Returns    []string
}

MethodInfo contains relevant information about each method in an interface

type StructExtractor

type StructExtractor struct{}

StructExtractor extracts information from struct declarations

func (StructExtractor) Extract

func (s StructExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, pkgName string) EntityInfo

type TypeExtractor

type TypeExtractor struct{}

TypeExtractor extracts information from type declarations

func (TypeExtractor) Extract

func (t TypeExtractor) Extract(decl ast.Decl, fs *token.FileSet, interfaces map[string]EntityInfo, pkgName string) EntityInfo