dir-tree-creator
v4.0.0
npm like directory tree structure creator based on the given root path
0/weekUpdated 3 years agoMIT
Published by Mani Maghsoudlou
npm install dir-tree-creatordir-tree-creator
================
dir-tree-creator is a Node.js module that creates an npm like directory tree structure of the given root path and returns the string representation of it.
Install
-------
npm i dir-tree-creator
Usage
-----
dirtree(dir[, opts], cb)
- dir
- opts (optional) object with the following properties:
- label
- hidden
- cb
- err
- dirtree
Example
-------
``js
const dirTree = require('dir-tree-creator')
dirTree('some/dir', (err, tr) => {
if (err) return console.error(err)
console.log(tr)
})
`
`js
const dirTree = require('dir-tree-creator')
dirTree('some/dir', { label: 'custom label' }, (err, tr) => {
if (err) return console.error(err)
console.log(tr)
})
`
Sample output
-------------
`
custom label
├─┬ dir0
│ └── file0.js
├─┬ dir1
│ ├─┬ dir2
│ │ └── file2.js
│ └── file1.md
├── file-under-root.js
└── .gitignore