node-map-directory v0.1.0

node-map-directory

Asyncronously map directory file structure into a JavaScript object

Install

$ npm install node-map-directory

Usage

var mapDir = require('node-map-directory');
mapDir('./')
  .then(function(currentDirMap) {
    // some code
  });

/* You will get an array of file and directory objects

  Directory structure
  - currentDir
    - index.html
    - scripts
      - myScript.js

  Output:
  [
    {
      name: 'index',
      extension: '.html',
      type: 'file'
    },
    {
      name: 'scripts',
      type: 'dir',
      children: [
        {
          name: 'myScript',
          extension: '.js',
          type: 'file'
        }
      ]
    }
  ]
*/

API

mapDir(directory, toIgnore)

options

directory

Type: String
Default: ./

The root directory to get the map from.

toIgnore

Type: array
Default: ['node_modules', 'bower_components', '.ignored_file']

The directories and files to exclude from mapping.

License

MIT © Dorian Camilleri