0.1.0 • Published 6 years ago

@linkcs/directory-tree v0.1.0

Weekly downloads
1
License
MIT
Repository
-
Last release
6 years ago

TL;DR

Create a list of a given path:

folder/
   ┣━━ foo/
   ┃    ┗━━ bar/
   ┃         ┗━━ javascript.js
   ┃         ┗━━ python.py
   ┃         ┗━━ database.sql
   ┃
   ┣━━ paz/
   ┃
   ┗━━ ska/
        ┗━━ ignore.txt
const getTree = require("@linkcs/directory-tree");

getTree("./folder");
// {
//   foo: {
//     bar: {
//       "javascript.js": null,
//       "python.py": null,
//       "database.sql": null
//     }
//   },
//   ska: {
//     "ignore.txt": null
//   }
// }

getTree("./folder", { extensions: ".py" });
// {
//   foo: {
//     bar: {
//       "javascript.js": null,
//       "python.py": null,
//       "database.sql": null
//     }
//   },
//   ska: {
//     "ignore.txt": null
//   }
// }

getTree("./folder", { includeFiles: false });
// {
//   foo: {
//     bar: { }
//   },
//   ska: { }
// }

Options

optiondescriptiondefault value
extensionsOnly include files of these extensions'.*'
ignoreExtensionsExclude files of these extensionsnull
ignoreFilesRegex to ignore certain files'\..*'
ignoreFoldersRegex to ignore certain folders'node_modules'
includeFilesShould list files in the treetrue

};