godecl is Deprecated: use go-astra instead.

godecl

Package to grub information about go file.

Install

go get -u github.com/vetcher/godecl

Description

Package godecl use ast.File from standard pkg to collect information about source file. For stable work 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
• 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/godecl"
)

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 := godecl.ParseFile(f)
	if err != nil {
		fmt.Println(err)
	}
	t, err := json.Marshal(file)
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(string(t))
}