get-dirs v2.2.0

get-dirs

Given a root directory, get-dirs will return a readable Stream that will push all sub-directories.

Allows for exclusions: strings to match, or RegExp instances. See usage.

Usage

const getDirs = require('get-dirs')

const matchDotFolders = /^\.\w+|\/\./ // RegExp to exclude any root or nested .dotFolders/
const exclusions = ['node_modules', matchDotFolders] // exclusions are optional

getDirs(__dirname, exclusions, readableStream => {
  readableStream
    .on('data', dir => {
      console.log(dir)
    })
    .on('end', () => {
      console.log('Listing of directories completed.')
    })
})

Tested on Mac OSX only so far.

note: running the above example in the node REPL will cause an error — the get-dirs module will claim that the RegExp is not actually an instanceof RegExp. I don't know why, but it will work fine run inside a js file. If anyone knows why please feel free to enlighten me.

Run unit tests

$ npm test