npm.io
0.2.1 • Published 6 years ago

@ngsctt/arborist

Licence
MIT
Version
0.2.1
Deps
0
Size
5 kB
Vulns
0
Weekly
0

arborist

What

A Node.js directory tree builder

Why

I initially tried using directory-tree, but found it wasn't flexible enough

How

Installation
npm i @ngsctt/arborist
Usage
const arborist = require('@ngsctt/arborist');

const rootDir = 'directory';      // relative to __dirname
const options = {
  stats: ["birthtime", "mtime"],  // lstatSync properties to include
  path: ["dir", "base", "name"],  // Node path properties to include
  exclude: ["^.DS_Store", "^_"]   // globs to exclude
}
const maxDepth = 10;              // maximum depth of tree

const tree = arborist(rootDir, options, maxDepth)

Licence

This project is released under the MIT Licence.