astra

README

Astra

Fetch information about go source file easily.

Install

go get -u github.com/vetcher/go-astra

Description

Package astra use ast.File from standard pkg to collect information about source file. It can collect information about:

• Imports
  • Docs
  • Packages
  • Aliases
• Constants
  • Name
  • Docs
  • Types
• Variables
  • Name
  • Docs
  • Types
  • Ignore variables which declared by function call!
• Interfaces
  • Name
  • Docs
  • Functions
• Structures
  • Docs
  • Fields (with tags)
  • Methods
• Functions
  • Name
  • Docs
  • Arguments
  • Results
• Methods (functions with receivers)
  • Name
  • Docs
  • Receiver
  • Arguments
  • Results
  • Linked structure

Usage example

package main

import (
	"encoding/json"
	"fmt"
	"go/ast"
	"go/parser"
	"go/token"
	"os"
	"path/filepath"

	"github.com/vetcher/go-astra"
)

func main() {
	currentDir, err := os.Getwd()
	if err != nil {
		panic(err)
	}
	path := filepath.Join(currentDir, "./test/service.go")
	fset := token.NewFileSet()
	f, err := parser.ParseFile(fset, path, nil, parser.ParseComments|parser.AllErrors)
	if err != nil {
		panic(fmt.Errorf("error when parse file: %v", err))
	}
	file, err := astra.ParseFile(f)
	if err != nil {
		fmt.Println(err)
	}
	t, err := json.Marshal(file)
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(string(t))
}

Documentation

Index

• Variables
• func GetPackage(path string, options ...Option) (*types.File, error)
• func IsCommonReceiver(t types.Type) bool
• func MergeFiles(files []*types.File) (*types.File, error)
• func ParseAstFile(file *ast.File, options ...Option) (*types.File, error)
• func ParseFile(filename string, options ...Option) (*types.File, error)
• func ParsePackage(path string, options ...Option) ([]*types.File, error)
• func ResolvePackagePath(outPath string) (string, error)
• type Option

Variables

var (
	ErrCouldNotResolvePackage = errors.New("could not resolve package")
	ErrUnexpectedSpec         = errors.New("unexpected spec")
	ErrNotInGoPath            = errors.New("not in GOPATH")
	ErrGoPathIsEmpty          = errors.New("GOPATH is empty")
)

Functions

func GetPackage

func GetPackage(path string, options ...Option) (*types.File, error)

func IsCommonReceiver

func IsCommonReceiver(t types.Type) bool

func MergeFiles

func MergeFiles(files []*types.File) (*types.File, error)

Merges parsed files to one. Helpful, when you need full information about package.

func ParseAstFile

func ParseAstFile(file *ast.File, options ...Option) (*types.File, error)

Parses ast.File and return all top-level declarations.

func ParseFile

func ParseFile(filename string, options ...Option) (*types.File, error)

Opens and parses file by name and return information about it.

func ParsePackage

func ParsePackage(path string, options ...Option) ([]*types.File, error)

Parses all .go files from directory. Deprecated: use GetPackage instead

func ResolvePackagePath

func ResolvePackagePath(outPath string) (string, error)

Types

type Option

type Option uint

const (
	IgnoreComments Option = 1 << iota
	IgnoreStructs
	IgnoreInterfaces
	IgnoreFunctions
	IgnoreMethods
	IgnoreTypes
	IgnoreVariables
	IgnoreConstants
	AllowAnyImportAliases
)