textree

textree

textree is a go package to easily pretty print nested trees in plain text.

Install

go get github.com/plouc/textree

Usage

import (
	"os"
	"github.com/plouc/textree"
)

Construct a tree:

root := textree.NewNode("1")

childA := textree.NewNode("1.1")
root.Append(childA)
childA.Append(textree.NewNode("1.1.1"))
childA.Append(textree.NewNode("1.1.2"))

childB := textree.NewNode("1.2")
root.Append(childB)
childB.Append(textree.NewNode("1.2.1"))

Then render the tree using the root element:

o := textree.NewRenderOptions()
root.Render(os.Stdout, o)

Listing a directory

You can get something similar to the tree command.

tree, err := textTree.TreeFromDir("./")
if err != nil {
    fmt.Printf("%v\n", err)
    return
}
	
tree.Render(os.Stdout, textree.NewRenderOptions())

For complete usage of textree, see the full package docs.

Examples

Some examples are available in the examples/ directory.

go run examples/main.go

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

  Basic example
    using default options

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ┌ ROOT
 │
 └──┬ 1
    │
    ├──┬ 1.1
    │  │
    │  ├─── 1.1.1
    │  └─── 1.1.2
    │
    ├──┬ 1.2
    │  │
    │  └─── 1.2.1
    │
    ├──┬ 1.3
    │  │
    │  ├─── 1.3.1
    │  ├──┬ 1.3.2
    │  │  │
    │  │  ├─── 1.3.2.1
    │  │  └─── 1.3.2.2
    │  │
    │  └─── 1.3.3
    │
    ├─── 1.4
    └─── 1.5


=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

  Dotted example
    using RenderOptions.Dotted()

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ┌ ROOT
 :
 ···· 1
    :
    :··· 1.1
    :  :
    :  :··· 1.1.1
    :  ···· 1.1.2
    :
    :··· 1.2
    :  :
    :  ···· 1.2.1
    :
    :··· 1.3
    :  :
    :  :··· 1.3.1
    :  :··· 1.3.2
    :  :  :
    :  :  :··· 1.3.2.1
    :  :  ···· 1.3.2.2
    :  :
    :  ···· 1.3.3
    :
    :··· 1.4
    ···· 1.5


=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

  Rounded example
    using RenderOptions.Rounded()

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ┌ ROOT
 │
 ╰──╮ 1
    │
    ├──╮ 1.1
    │  │
    │  ├─── 1.1.1
    │  ╰─── 1.1.2
    │
    ├──╮ 1.2
    │  │
    │  ╰─── 1.2.1
    │
    ├──╮ 1.3
    │  │
    │  ├─── 1.3.1
    │  ├──╮ 1.3.2
    │  │  │
    │  │  ├─── 1.3.2.1
    │  │  ╰─── 1.3.2.2
    │  │
    │  ╰─── 1.3.3
    │
    ├─── 1.4
    ╰─── 1.5


=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

  Compact example
    using RenderOptions.Compact()

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ┌ ROOT
 └─┬ 1
   ├─┬ 1.1
   │ ├── 1.1.1
   │ └── 1.1.2
   ├─┬ 1.2
   │ └── 1.2.1
   ├─┬ 1.3
   │ ├── 1.3.1
   │ ├─┬ 1.3.2
   │ │ ├── 1.3.2.1
   │ │ └── 1.3.2.2
   │ └── 1.3.3
   ├── 1.4
   └── 1.5

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

  Directory listing example
    using TreeFromDir()

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ┌ ./snapshots
 │
 ├─── basic.snap
 ├─── dotted.snap
 └─── rounded.snap