Package Exports

ascii-tree

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ascii-tree) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ascii-tree

A node module for generating a text tree in ASCII

Editing an ASCII tree manually is not easy, the freetree module provides an easy way for creating in-memory tree data structure from simple bullet items. This [ascii-tree](https://github.com/liushuping/ascii-tree module leverages) module leverages freetree and outputs formatted tree in ascii characters.

Code Example

Prepare an input file (input.txt) using bullets representing a tree e.g.

#root node
##node1
###node11
##node2

and then process the file content with ascii-tree to generate the ascii tree.

var fs = require('fs');
var asciitree = require('ascii-tree');
var str = fs.readFileSync('input.txt', 'utf8');
var tree = asciitree.generate(str);
fs.writeFile('output.txt', tree, 'utf8');

Then the output.txt will have below contents

root node
├─ node1
│  └─ node11
└─ node2

Test

Make sure mocha is installed globally

npm install mocha -g

Run npm test to run unit test

Dependencies

ascii-tree uses freetree for creating tree data structure from inputting text

License

MIT