codysmithd / pretty-file-tree

A tiny, simple utility for pretty-printing lists of file paths as a tree for command-line-interfaces.

pretty-file-tree

A tiny, simple utility for pretty-printing lists of file paths as a tree for command-line-interfaces.

Example

const prettyTree = require('pretty-file-tree');

console.log(prettyTree([
    'home/user/foo.js',
    'home/user/test/bar.js',
    'home/user/test/baz.js',
    'home/user/bat.js'
]));

Result

home/user
├── foo.js
├── test
|  ├── bar.js
|  └── baz.js
└── bat.js

Configuring the output tree style

It is possible to change the style of the tree.

Example

const prettyTree = require('pretty-file-tree');

const options = {
    throughTee: '├>',
    endTee: '└>' 
}

console.log(prettyTree([
    'home/user/foo.js',
    'home/user/test/bar.js',
    'home/user/test/baz.js',
    'home/user/bat.js'
], options));

Result

home/user
├> foo.js
├> test
|  ├> bar.js
|  └> baz.js
└> bat.js

Style Options

throughTee

• throughTee option refers to the "├──" default string.

endTee

• endTee option refers to the "└──" default string.

vertical

• vertical option refers to the "| " default string.

emptyColumn

• emptyColumn option refers to the " " default string.

pretty-file-tree's Issues

Param for specifying tabulation?

Hi @codysmithd!

Thanks for a great lib – it's very useful 👏
I'm wondering if you could add an option to customize the number of spaces between | at different file system levels?
By default, it's 2 spaces (space = 2x" "), like this:

├── dir
|  ├── file_1.txt
|  ├── subdir
|  |  ├── file_1.txt
|  |  ├── file_2.txt
|  |  └── file_3.txt
|  └── file_2.txt
└── file.txt

But I'm wondering if you could add an option to do this? (space = 3x" ")

├── dir
|   ├── file_1.txt
|   ├── subdir
|   |   ├── file_1.txt
|   |   ├── file_2.txt
|   |   └── file_3.txt
|   └── file_2.txt
└── file.txt

Or this? (space = 4x" ")

├── dir
|    ├── file_1.txt
|    ├── subdir
|    |    ├── file_1.txt
|    |    ├── file_2.txt
|    |    └── file_3.txt
|    └── file_2.txt
└── file.txt

Or any other arbitrary number of spaces?

Publish the change with options

The style options change in August of 2021 are not in NPM vs 1.0.1. Would it possible to make another release with the latest repo?