tree-printer v1.1.1

tree-printer

CLI module to pretty print a tree generated from a collection (array of objects).

Example

var treePrinter = require('tree-printer

console.log(treePrinter([
	{
		name: 'Foo',
		children: [
			{name: 'Foo-Foo'},
			{name: 'Foo-Bar'},
			{name: 'Foo-Baz'},
		],
	},
	{
		name: 'Bar',
		children: [
			{name: 'Bar-Foo'},
			{name: 'Bar-Bar'},
			{
				name: 'Bar-Baz',
				children: [
					{name: 'Bar-Baz-Foo'},
					{name: 'Bar-Baz-Bar'},
					{name: 'Bar-Baz-Baz'},
				],
			},
		],
	},
	{
		name: 'Baz',
		children: [
			{name: 'Baz-Foo'},
			{name: 'Baz-Bar'},
			{name: 'Baz-Baz'},
		],
	},
]));

Outputs:

┬
├─┬ Foo
│ ├── Foo-Foo
│ ├── Foo-Bar
│ └── Foo-Baz
├─┬ Bar
│ ├── Bar-Foo
│ ├── Bar-Bar
│ └─┬ Bar-Baz
│   ├── Bar-Baz-Foo
│   ├── Bar-Baz-Bar
│   └── Bar-Baz-Baz
└─┬ Baz
  ├── Baz-Foo
  ├── Baz-Bar
  └── Baz-Baz

Options

The main treePrinter(tree, options) function takes the collection and an object of options which can be any, all or none of the following: