directory-tree

What is directory-tree?

The directory-tree npm package is a utility for generating a nested directory structure in JSON format. It is useful for visualizing and working with file system hierarchies in a programmatic way.

What are directory-tree's main functionalities?

Generate Directory Tree

This feature allows you to generate a JSON representation of a directory structure starting from a specified path. The code sample demonstrates how to use the package to create a directory tree and print it in a readable JSON format.

const dirTree = require('directory-tree');
const tree = dirTree('/some/path');
console.log(JSON.stringify(tree, null, 2));

Filter by File Extensions

This feature allows you to filter the files included in the directory tree by their extensions. The code sample shows how to generate a directory tree that only includes Markdown and JavaScript files.

const dirTree = require('directory-tree');
const tree = dirTree('/some/path', { extensions: /\.(md|js)$/ });
console.log(JSON.stringify(tree, null, 2));

Exclude Specific Paths

This feature allows you to exclude specific paths from the directory tree. The code sample demonstrates how to exclude the 'node_modules' directory from the generated tree.

const dirTree = require('directory-tree');
const tree = dirTree('/some/path', { exclude: /node_modules/ });
console.log(JSON.stringify(tree, null, 2));

Other packages similar to directory-tree

readdirp

Readdirp is a recursive version of fs.readdir with additional features like filtering and streaming. It provides more control over the file reading process compared to directory-tree, which is more focused on generating a static JSON structure.

klaw

Klaw is a file system walker that streams file paths as it traverses directories. It offers more flexibility and streaming capabilities compared to directory-tree, which is primarily used for generating a complete directory snapshot in JSON format.

fs-extra

Fs-extra extends the native Node.js fs module with additional methods, including recursive directory operations. While it doesn't directly generate directory trees, it provides utilities that can be used to build similar functionality with more manual control.

README

#directory-tree

Creates an javascript object representing a directory tree.

Install

npm i -S directory-tree

##Usage

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

And you can also filter by extensions:

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

This will take a directory tree:

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

And return a js object:

{
  "path": "photos",
  "name": "photos",
  "size": 600,
  "children": [
    {
      "path": "photos/summer",
      "name": "summer",
      "size": 400,
      "children": [
        {
          "path": "photos/summer/june",
          "name": "june",
          "size": 400,
          "children": [
            {
              "path": "photos/summer/june/windsurf.jpg",
              "name": "windsurf.jpg",
              "size": 400,
              "extension": ".jpg"
            }
          ]
        }
      ]
    },
    {
      "path": "photos/winter",
      "name": "winter",
      "size": 200,
      "children": [
        {
          "path": "photos/winter/january",
          "name": "january",
          "size": 200,
          "children": [
            {
              "path": "photos/winter/january/ski.png",
              "name": "ski.png",
              "size": 100,
              "extension": ".png"
            },
            {
              "path": "photos/winter/january/snowboard.jpg",
              "name": "snowboard.jpg",
              "size": 100,
              "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 dependcies installed (e.g. npm install .)

Node version

Check out version 0.1.1 if you need support for older versions of node.