tree

README

tree

Simple go project to tree structure. It supports only go files.

???

package main

import (
	"fmt"
	"go/ast"

	"github.com/andream16/tree"
)

func main() {

	out, err := tree.Get("examples/example", &tree.Node{})
	if err != nil {
		panic(err)
	}

	fmt.Println(out.Name)                   // example
	fmt.Println(out.Leafs[0].Name)          // somefile.go
	fmt.Println(out.Leafs[0].Path)          // examples/example/somefile.go
	fmt.Println(out.Nodes[0].Name)          // example/subexample
	fmt.Println(out.Nodes[0].Leafs[0].Name) // someotherfile.go
	fmt.Println(out.Nodes[0].Leafs[0].Path) // examples/example/subexample/someotherfile.go

	err = out.Leafs[0].Ast()
	if err != nil {
		panic(err)
	}

	ast.Inspect(out.Leafs[0].SyntaxTree, func(n ast.Node) bool {
		var s string
		switch x := n.(type) {
		case *ast.BasicLit:
			s = x.Value
		case *ast.Ident:
			s = x.Name
		}
		if s != "" {
			fmt.Printf("%s\n", s) // example
		}
		return true
	})

	// example
	// |       somefile.go
	// example/subexample
	// |       someotherfile.go
	out.Print()

}

Documentation

Index

• type Leaf
  • func (l *Leaf) Ast() error
• type Node
  • func Get(path string, node *Node) (*Node, error)
  • func (n *Node) Print()
• type Treer

Types

type Leaf

type Leaf struct {
	Name       string
	Path       string
	SyntaxTree *ast.File
}

Leaf represents a go file.

func (*Leaf) Ast

func (l *Leaf) Ast() error

Ast sets leaf's SyntaxTree

type Node

type Node struct {
	Name  string
	Nodes []*Node
	Leafs []Leaf
}

Node represents a package (directory) that can contain other sub-packages.

func Get

func Get(path string, node *Node) (*Node, error)

Get returns all go files in the repository by directory name

func (*Node) Print

func (n *Node) Print()

Print pretty prints go project structure

type Treer

type Treer interface {
	Get(string, *Node) (*Node, error)
	Ast(*Leaf) error
}

Treer allows third party mocking