directory-tree

Creates a JavaScript object representing a directory tree.

Install

$ npm install directory-tree

Usage

const dirTree = require('directory-tree');
const tree = dirTree('/some/parentPath','/subPath');

And you can also filter by an extensions regex: This is useful for including only certain types of files.

const dirTree = require('directory-tree');
const filteredTree = dirTree('/some/parentPath','/subPath', {extensions:/\.txt/});

You can also exclude paths from the tree using a regex:

const dirTree = require('directory-tree');
const filteredTree = dirTree('/some/parentPath','/subPath', {exclude:/some_path_to_exclude/});

A callback function can be executed with each file that matches the extensions provided:

const PATH = require('path');
const dirTree = require('directory-tree');

const tree = dirTree('/some/parentPath','/subPath', {extensions:/\.txt$/}, (item, PATH) => {
	console.log(item);
});

The callback function takes the directory item (has path, name, size, and extension) and an instance of node path.

Result

Given a directory structured like this:

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

directory-tree will return this JS object: NOTE: parent Path is intentionally omitted to support intentional hiding of the full path e.g. to client-side application

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

Note

Device, FIFO and socket files are ignored.

Files to which the user does not have permissions are included in the directory tree, however, directories to which the user does not have permissions, along with all of its contained files, are completely ignored.

Dev

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

$ npm test

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

Node version

This project requires at least Node v4.2. Check out version 0.1.1 if you need support for older versions of Node.