directory-tree 3.0.0 → 3.2.1

package/.idea/encodings.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" addBOMForNewFiles="with NO BOM" />
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/node-directory-tree.iml" filepath="$PROJECT_DIR$/.idea/node-directory-tree.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/node-directory-tree.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -83,6 +83,8 @@ const tree = dirTree('./test/test_data', {extensions:/\.txt$/}, null, (item, PAT
 
 `normalizePath` : `Boolean` - If true, windows style paths will be normalized to unix style pathes (/ instead of \\).
 
+`depth` : `number` - If presented, reads so many nested dirs as specified in argument. Usage of size attribute with depth option is prohibited.
+
 ## Result
 
 Given a directory structured like this:
@@ -164,6 +166,33 @@ photos
 }
 ```
 
+## Adding custom fields
+You can easily extend a `DirectoryTree` object with custom fields by adding them to the custom field.
+For example add an `id` based on the path of a `DirectoryTree` object for each directory and file like so:
+```
+import { createHash } from 'crypto';
+import * as directoryTree from 'directory-tree';
+import { DirectoryTree, DirectoryTreeOptions, DirectoryTreeCallback } from 'directory-tree';
+
+const callback: DirectoryTreeCallback = (
+            item: DirectoryTree,
+            path: string
+        ) => {
+            item.custom.id = createHash('sha1').update(path).digest('base64');
+        };
+
+const dirTree: DirectoryTree & { id?: string } = directoryTree(
+    "<your-directory-path>",
+    {},
+    callback,
+    callback
+);
+
+// to explore the object with the new custom fields
+console.log(JSON.stringify(dirTree, null, 2));
+
+```
+
 ## Note
 
 Device, FIFO and socket files are ignored.
@@ -186,3 +215,22 @@ Make sure you have the dev dependencies installed (e.g. `npm install .`)
 
 This project requires at least Node v4.2.
 Check out version `0.1.1` if you need support for older versions of Node.
+
+## CLI usage
+
+You can use script directly from command line for generating json data.
+
+```bash
+$ npx directory-tree --help
+```
+```bash
+$ npx directory-tree --path /Users/user/target --attributes type,extension --pretty -o ./xz.json --depth 1 
+```
+
+### Available options
+-p, --path string      🗂 The input folder to process. Required.                                     
+-e, --exclude string   🐒 Exclude some folders from processing by regexp string. Ex -e "test_data/some_dir$|js|.DS_Store"                                            
+-o, --output string    📝 Put result into file provided by this options. Overwrites if exists.       
+-d, --depth number     ☞ Reads dirs in deep as specified. Usage of size attribute with depth option is prohibited.                                                                
+--attributes string    ℹ️ Grab file attributes. Example: --attributes size,type,extension. Usage of size attribute with depth option is prohibited                                
+--pretty               💎 Json pretty print

package/bin/index.js

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const commandLineUsage = require('command-line-usage')
+const commandLineArgs = require('command-line-args')
+const directoryTree = require('../lib/directory-tree');
+
+const optionList = [
+    {
+        name: 'path',
+        alias: 'p',
+        required: true,
+        defaultOption: true,
+        typeLabel: '{underline string}',
+        description: '🗂 The input folder to process. Required.'
+    },
+    {
+        name: 'exclude',
+        alias: 'e',
+        type: String,
+        description: '🐒 Exclude some folders from processing by regexp string. Ex -e "test_data/some_dir$|js|.DS_Store"'
+    },
+    {
+        name: 'output',
+        alias: 'o',
+        type: String,
+        description: '📝 Put result into file provided by this options. Overwrites if exists.'
+    },
+    {
+        name: 'depth',
+        alias: 'd',
+        type: Number,
+        description: '☞ Reads dirs in deep as specified. Usage of size attribute with depth option is prohibited.'
+    },
+    {
+        name: 'attributes',
+        type: String,
+        description: 'ℹ️ Grab file attributes. Example: --attributes size,type,extension. Usage of size attribute with depth option is prohibited'
+    },
+    {
+        name: 'pretty',
+        type: Boolean,
+        description: '💎 Json pretty print'
+    },
+    {
+        name: 'help',
+        alias: 'h',
+        type: Boolean,
+        description: '⁉️ Print this usage guide.'
+    }
+]
+
+const usageNotes = [
+    {
+        header: '⛄️️ Folder-tree command line script',
+        content: 'Used for generates json representation of folder internals'
+    },
+    {
+        header: '🔥 Options 🔥',
+        optionList: optionList
+    }
+]
+
+const usage = commandLineUsage(usageNotes)
+let options = null;
+try {
+    options = commandLineArgs(optionList)
+} catch(e) {
+    console.log(usage);
+    return;
+}
+
+if (Object.keys(options).length === 0 || options.help || !options.path) {
+    console.log(usage)
+    return;
+}
+
+if (!fs.existsSync(options.path)) {
+    console.log('-----------------------------------------------------------------------------------------------------')
+    console.log(`doesn't exist; please check your args`);
+    console.log('-----------------------------------------------------------------------------------------------------')
+    console.log(usage)
+    return;
+}
+
+try {
+    const result = directoryTree(options.path, {
+        depth: options.depth,
+        exclude: options.exclude ? [new RegExp(options.exclude)] : undefined,
+        attributes: options.attributes ? options.attributes.split(',') : undefined
+    })
+
+    const resultString = JSON.stringify(result, null, options.pretty ? '  ' : '');
+    if (options.output) {
+        fs.writeFileSync(options.output, resultString);
+    } else {
+        console.log(resultString);
+    }
+} catch(e) {
+    console.log(e);
+    console.log(usage);
+}

package/index.d.ts

@@ -18,13 +18,15 @@ declare namespace directoryTree {
     children ? : DirectoryTree[];
     extension?: string;
     isSymbolicLink?: boolean;
+    custom: { [key: string]: any };
   }
   export interface DirectoryTreeOptions {
     normalizePath ? : boolean;
     exclude ? : RegExp | RegExp[];
-    attributes ? : (keyof Stats)[];
+    attributes ? : (keyof Stats | "type" | "extension")[];
     extensions ? : RegExp;
     followSymlink ? : boolean;
+    depth ? : number;
   }
   export type DirectoryTreeCallback = (item: DirectoryTree, path: string, stats: Stats) => void;
 }

package/lib/directory-tree.js

@@ -48,9 +48,14 @@ function isRegExp(regExp) {
  * @param  {function} onEachDirectory
  * @return {Object}
  */
-function directoryTree (path, options, onEachFile, onEachDirectory) {
-  const name = PATH.basename(path);
+function directoryTree (path, options, onEachFile, onEachDirectory, currentDepth = 0) {
   options = options || {};
+
+  if (options.depth !== undefined && options.attributes.indexOf('size') !== -1) {
+    throw new Error('usage of size attribute with depth option is prohibited');
+  }
+
+  const name = PATH.basename(path);
   path = options.normalizePath ? normalizePath(path) : path;
   const item = { path, name };
   let stats;
@@ -119,9 +124,11 @@ function directoryTree (path, options, onEachFile, onEachDirectory) {
     let dirData = safeReadDirSync(path);
     if (dirData === null) return null;
 
-    item.children = dirData
-      .map(child => directoryTree(PATH.join(path, child), options, onEachFile, onEachDirectory))
-      .filter(e => !!e);
+    if (options.depth === undefined || options.depth > currentDepth) {
+      item.children = dirData
+          .map(child => directoryTree(PATH.join(path, child), options, onEachFile, onEachDirectory, currentDepth + 1))
+          .filter(e => !!e);
+    }
 
     if (options.attributes) {
       options.attributes.forEach((attribute) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directory-tree",
-  "version": "3.0.0",
+  "version": "3.2.1",
   "description": "Convert a directory tree to a JS object.",
   "repository": {
     "type": "git",
@@ -17,10 +17,15 @@
     "url": "https://github.com/mihneadb/node-directory-tree/issues"
   },
   "homepage": "https://github.com/mihneadb/node-directory-tree",
+  "dependencies": {
+    "command-line-args": "^5.2.0",
+    "command-line-usage": "^6.1.1"
+  },
   "devDependencies": {
     "chai": "^2.3.0",
     "mocha": "^8.3.2"
   },
+  "bin": "bin/index.js",
   "engines": {
     "node": ">=10.0"
   },