Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ascii-tree

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ascii-tree

A node module for generating a text tree in ASCII

  • 0.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

ascii-tree

A node module for generating a text tree in ASCII

build status

This module generates an ascii tree representation for a given string bullet list.

Generate for a given string bullet list.

var asciitree = require('ascii-tree');
var input = '#root node\r\n##node1\r\n###\r\nnode1\r\n##node2';
var tree = asciitree.generate(str);

the output string tree will be in below representation

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

The leading character is not necessary to be #, but can be any character, this is helpful to resolve the confliction between the leading character and actual content character.

var asciitree = require('ascii-tree');
var input = '*root node\r\n**node1\r\n***\r\nnode1\r\n**node2';
var tree = asciitree.generate(str);

The line break charachters \r\n are required.

Generate from an input file

First prepare an input file using bullets representating a tree

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

again, the leading character is not necessary to be # but can be any character. 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');

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

Keywords

FAQs

Package last updated on 28 Jun 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc