AnthonyPanchenko / node-directory-tree

Convert a directory tree to a JS object.

#directory-tree

Creates an object representing a directory tree.

From:

photos
├── summer
│   └── june
│       └── windsurf.jpg
└── winter
    └── january
        ├── ski.png
        └── snowboard.jpg

To:

{
  "path": "",
  "name": "photos",
  "size": 600,
  "type": "directory",
  "children": [
    {
      "path": "summer",
      "name": "summer",
      "size": 400,
      "type": "directory",
      "children": [
        {
          "path": "summer/june",
          "name": "june",
          "size": 400,
          "type": "directory",
          "children": [
            {
              "path": "summer/june/windsurf.jpg",
              "size": 400,
              "name": "windsurf.jpg",
              "type": "file"
            }
          ]
        }
      ]
    },
    {
      "path": "winter",
      "name": "winter",
      "size": 200,
      "type": "directory",
      "children": [
        {
          "path": "winter/january",
          "name": "january",
          "size": 200,
          "type": "directory",
          "children": [
            {
              "path": "winter/january/ski.png",
              "name": "ski.png",
              "size": 100,
              "type": "file"
            },
            {
              "path": "winter/january/snowboard.jpg",
              "name": "snowboard.jpg",
              "size": 100,
              "type": "file"
            }
          ]
        }
      ]
    }
  ]
}

##Usage

var dirTree = require('directory-tree');
var tree = dirTree.directoryTree('/some/path');

And you can also filter by extensions:

var dirTree = require('directory-tree');
var filteredTree = dirTree.directoryTree('/some/path', ['.jpg', '.png']);

Dev

To run tests go the package root in your CLI and run,

$ mocha

Make sure you have the dev dependcies installed (e.g. npm install .)