fs-file-tree

Get a directory file tree as an object.

☁️ Installation

# Using npm
npm install --save fs-file-tree

# Using yarn
yarn add fs-file-tree

📋 Example

const fsFileTree = require("fs-file-tree");

// File tree looks like this:
// .
// ├── a
// │   ├── b
// │   │   ├── c
// │   │   └── test.js
// │   └── two\ words
// └── index.js

// The tree object looks like this:
fsFileTree(__dirname, (err, tree) => {
    console.log(tree);
    // { a:
    //    { b: { c: {}, 'test.js': [Object] },
    //      'two words':
    //       { path: '.../example/a/two words',
    //         stat: [Object] } },
    //   'index.js':
    //    { path: '.../example/index.js',
    //      stat:
    //       {...} } }
});

console.log(fsFileTree.sync(__dirname, { camelCase: true }));
// { a:
//    { b: { c: {}, testJs: [Object] },
//      twoWords:
//       { path: '.../example/a/two words',
//         stat: [Object] } },
//   indexJs:
//    { path: '.../example/index.js',
//      stat:
//       {...} } }

// Promise/async-await interface
(async () => {
    const tree = await fsFileTree(__dirname)
    console.log(tree)
})()

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

fsFileTree(inputPath, opts, cb)

Get a directory file tree as an object.

Params

• String inputPath: The input path.
• Object opts: An object containing the following fields:
• camelCase (Boolean): Convert the file names in camelcase format (to be easily accessible using dot notation).
• all (Boolean): If true, it will include the hidden files/directories.
• Function cb: The callback function.

sync(inputPath, opts)

The sync version.

Params

• String inputPath: The input path.
• Object opts: An object containing the following fields:
• camelCase (Boolean): Convert the file names in camelcase format (to be easily accessible using dot notation).
• all (Boolean): If true, it will include the hidden files/directories.

Return

• Object The directory tree.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• bloggify
• bloggify-cli
• bloggify-flexible-router

📜 License

MIT © Ionică Bizău