Code Monkey home page Code Monkey logo

consoletree's Introduction

ConsoleTree

language issues version release downloads

A tool to write a tree structure to the console standard output stream, with colors support and a lot of customization options.

Getting started

To add ConsoleTree to your project, you can use the following NuGet Package Manager command:

Install-Package ConsoleTree

More options are available on the ConsoleTree page of the NuGet Gallery website.

Usage

Implement the ITreeNode interface to obtain the node of a tree structure. Optionally override the ToString method to provide a custom text for the node. To write a tree structure to the console standard output stream, call the Tree.Write method specifying its root node as parameter.

class TreeNode : ITreeNode
{
	public string Text { get; set; }
	public List<TreeNode> Nodes { get; set; } = new List<TreeNode>();

	public IEnumerable<ITreeNode> GetNodes()
	{
		return Nodes;
	}

	public override string ToString()
	{
		return Text;
	}
}

var tree = new TreeNode
{
	Text = "a",
	Nodes = new List<TreeNode>
	{
		new TreeNode { Text = "b"},
		new TreeNode { Text = "c"}
	}
};

Tree.Write(tree, new DisplaySettings { IndentSize = 2 });

// Output:
//
// a
// ├──b
// └──c

If it is not possible or not desired to implement the ITreeNode interface, then use the Tree.Write<T> method overloads.

sealed class TreeNode
{
	public string Text { get; set; }
	public List<TreeNode> Nodes { get; set; } = new List<TreeNode>();
}

var tree = new TreeNode
{
	Text = "a",
	Nodes = new List<TreeNode>
	{
		new TreeNode { Text = "b"},
		new TreeNode { Text = "c"}
	}
};

Tree.Write(tree, (node, level) => Console.Write(node.Text), (node, level) => node.Nodes, new DisplaySettings { IndentSize = 2 });

// Output:
//
// a
// ├──b
// └──c

Resources

See the API reference and the ConsoleTree.Demo application to learn how to customize indentation, maximum depth, type of connectors and colors.

consoletree's People

Contributors

maurizuki avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.