Node.js convert directory tree to JSON

Question

What is expected?:
I would like to convert the below listed directory structure into a single JSON file. The directory structure contains JSON files that are supposed to be included in the output file as well.

Limitations:
Node.js

Questions:
What would be a good/efficient way to generate the desired output, using Node.js + Modules? Logically, what would be the necessary steps?

Directory structure:

CMS/
├── en/
|   ├──brand_one/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_two/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_three/
|   |  ├──footer.json
|   |  ├──header.json
├── de/
|   ├──brand_one/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_two/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_three/
|   |  ├──footer.json
|   |  ├──header.json
├── fr/
|   ├──brand_one/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_two/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_three/
|   |  ├──footer.json
|   |  ├──header.json
├── es/
|   ├──brand_one/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_two/
|   |  ├──footer.json
|   |  ├──header.json
|   ├──brand_three/
|   |  ├──footer.json
|   |  ├──header.json

[...]

Desired output:

// content.json

{
  "en":[
    {
      "brand_one":{
        "footer":{
          "val": "value",
          [...]
        },
        "header":{
          "val": "value",
          [...]
        }
      },
      "brand_two":{
        "footer":{
          "val": "value",
          [...]
        },
        "header":{
          "val": "value",
          [...]
        }
      },
      "brand_three":{
        "footer":{
          "val": "value",
          [...]
        },
        "header":{
          "val": "value",
          [...]
        }
      }
    }
  ],
  [...]
}

Check it out here. stackoverflow.com/questions/11194287/…

Doumor
– Doumor

2021-11-15 12:58:21 +00:00
Commented Nov 15, 2021 at 12:58 — Doumor
– Doumor, Commented Nov 15, 2021 at 12:58

Doumor · Accepted Answer · 2021-11-15 13:02:40Z

3

You may use npm package tree-parser.

https://www.npmjs.com/package/tree-parser

answered Nov 15, 2021 at 13:02

Doumor

5591 gold badge5 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Terry Lennox · Accepted Answer · 2021-11-15 13:46:52Z

You could create a function to convert a directory to an object, with a property for each dir / file.

This would then be called recursively to walk the entire tree, in this case using the fs/promises functions.

const fs = require('fs/promises'); 
const path = require('path');

async function walkDir(dir, result = {}) {
    let list = await fs.readdir(dir);
    for(let item of list) {
        const itemPath = path.join(dir, item);
        let stats = await fs.stat(itemPath)
        if (await stats.isDirectory()) {
            result[item] = {};
            await walkDir(itemPath, result[item]);
        } else {
            const fileName = path.basename(item, path.extname(item));
            result[fileName] = JSON.parse(await fs.readFile(itemPath, { encoding: 'utf-8'}));
        }
    }
    return result;
}

async function testWalkDir() {
    let result = await walkDir('./CMS')
    console.log("Result:", JSON.stringify(result, null, 2));
}

testWalkDir();

Assuming each file looks like

{
  "some_key": "some_val"
}

I get a result that looks like so:

{
  "en": {
    "brand_one": {
      "footer": {
        "some_key": "some_val"
      },
      "header": {
        "some_key": "some_val"
      }
    },
    "brand_three": {
      "footer": {
        "some_key": "some_val"
      },
      "header": {
        "some_key": "some_val"
      }
    },
    "brand_two": {
      "footer": {
        "some_key": "some_val"
      },
      "header": {
        "some_key": "some_val"
      }
    }
  }
}

EuberDeveloper · Accepted Answer · 2023-09-21 18:57:07Z

You can try this module:

npm dree

Example code:

const dree = require('dree');

const options = {
    stat: false,
    normalize: true,
    followLinks: true,
    size: true,
    hash: true,
    depth: 5,
    exclude: /dir_to_exclude/,
    extensions: [ 'txt', 'jpg' ]
};

const tree = dree.scan('./folder', options);

There are lots of custom options, a result could be this:

{
  "name": "sample",
  "path": "D:/Github/dree/test/sample",
  "relativePath": ".",
  "type": "directory",
  "size": "1.81 MB",
  "children": [
    {
      "name": "backend",
      "path": "D:/Github/dree/test/sample/backend",
      "relativePath": "backend",
      "type": "directory",
      "size": "1.79 MB",
      "children": [
        {
          "name": "firebase.json",
          "path": "D:/Github/dree/test/sample/backend/firebase.json",
          "relativePath": "backend/firebase.json",
          "type": "file",
          "extension": "json",
          "size": "29 B"
        }, 
        {
          "name": "server",
          "path": "D:/Github/dree/test/sample/backend/server",
          "relativePath": "backend/server",
          "type": "directory",
          "size": "1.79 MB",
          "children": [
            {
              "name": "server.js",
              "path": "D:/Github/dree/test/sample/backend/server/server.js",
              "relativePath": "backend/server/server.js",
              "type": "file",
              "extension": "js",
              "size": "1.81 MB"
            }
          ]
        }
      ]
    }
  ]
}

Even a string could be returned, like this:

sample
 └─> backend
     ├── firebase.json
     ├── hello.txt
     └─> server
         └── server.js

Collectives™ on Stack Overflow

Node.js convert directory tree to JSON

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related