dir-tree-creator

#dir-tree-creator

dir-tree-creator is a tiny module that creates an npm like directory tree structure of the given path and returns the string representation of it.

####Install

Please use npm install dir-tree-creator.

####API

dirtree(options, cb)

• options {Object}

• root {String} root path

• label {String} (optional) label for the root node of the directory tree; if nothing specified, then the root path's basename will be used.

• ignore {Array} (optional) an array of node-glob patterns to ignore. By default, node_modules and .git are ignored.

• cb {Function}

• err {Error | null}

• dirtree {String} String representation of the directory structure

const dir_tree = require('dir-tree-creator');

var opts = {
  root: __dirname,
  label: 'your custom label',
  ignore: ['foo.js', 'test/**'] // ignore foo.js and test dir
};

dir_tree(opts, (er, tr) => {
  if (er) {
    console.error(er);
  } else {
    console.log(tr);
  }
});

#####Sample output

your custom label
├─┬ dir0
│ └── file0.js  
├─┬ dir1
│ ├─┬ dir2  
│ │ └── file2.js  
│ └── file1.md 
├── file-under-root.js
└── .gitignore