feat: add configuration of max depth limit while generating tree string for directory

Author: aprilandjan

README.md

@@ -59,7 +59,7 @@ In addition to being able to format pre-formatted tree strings, you may also gen
 
 The walking process through files is performed asynchronously. Therefore, selecting heavily-nested folders (e.g. `node_modules`) will directly affect performance speed.
 
-By default, `node_modules` and `.git` are ignored while generating tree string for directories. However, this can be customized by setting `asciiTreeGenerator.directoryIgnore` in configurations.
+By default, `node_modules` and `.git` are ignored while generating tree string for directories. However, this can be customized by setting `asciiTreeGenerator.directoryIgnore` in configurations. Also, setting `asciiTreeGenerator.directoryMaxDepth` can limit the depth of directory walking-through.
 
 ## Configuration
 

package.json

@@ -70,7 +70,12 @@
               "type": "string"
             },
             "default": ["node_modules", ".git"],
-            "description": "the glob patterns of ignored path while generate tree string for directory"
+            "description": "The glob patterns of ignored path while generate tree string for directory"
+          },
+          "asciiTreeGenerator.directoryMaxDepth": {
+            "type": "integer",
+            "default": 0,
+            "description": "The max walk-through depths while generate tree string for directory. Set to 0 means no limitation."
           }
         }
       }

src/config.ts

@@ -4,6 +4,7 @@ import { IVsCodeConfig } from './lib/interface';
 export function getConfig(): IVsCodeConfig {
   const config: IVsCodeConfig = {
     directoryIgnore: vscode.workspace.getConfiguration().get<string[]>('asciiTreeGenerator.directoryIgnore'),
+    directoryMaxDepth: vscode.workspace.getConfiguration().get<number>('asciiTreeGenerator.directoryMaxDepth'),
     rootCharCode: vscode.workspace
       .getConfiguration()
       .get<number>('asciiTreeGenerator.rootElement'),

src/extension.ts

@@ -6,7 +6,7 @@ import * as path from 'path';
 
 import { formatFileTreeItemsFromDirectory } from './lib/directory';
 import { generate } from './lib/generator';
-import { getUserEOL, createWebview, revertTreeString, getCharCodesFromConfig, getDirectoryIgnoreFromConfig } from './utils';
+import { getUserEOL, createWebview, revertTreeString, getCharCodesFromConfig, getDirectoryIgnoreFromConfig, getDirectoryMaxDepthFromConfig } from './utils';
 import { formatFileTreeItemsFromText } from './lib/text';
 
 export function activate(context: vscode.ExtensionContext) {
@@ -63,9 +63,9 @@ export function activate(context: vscode.ExtensionContext) {
         path.relative(rootWorkspace.uri.fsPath, target.fsPath) || '.';
 
       const items = await formatFileTreeItemsFromDirectory(target!.fsPath, {
-        maxDepth: Number.MAX_VALUE,
-        sort: true,
         ignore: getDirectoryIgnoreFromConfig(),
+        maxDepth: getDirectoryMaxDepthFromConfig(),
+        sort: true,
       });
       const text = generate(items, {
         eol: getUserEOL(),

src/lib/interface.ts

@@ -36,6 +36,7 @@ export interface ICharset {
 
 //  the VS code config interface
 export interface IVsCodeConfig {
+  directoryMaxDepth: number | undefined;
   directoryIgnore: string[] | undefined;
   rootCharCode: number | undefined;
   childCharCode: number | undefined;

src/test/lib/directory.test.ts

@@ -41,6 +41,14 @@ suite('lib/directory functions', function () {
     assert(findFileByName(files, '.env') === undefined);
   });
 
+  test('should correctly list directories when recursively into depth 3', async () => {
+    const files = await listDirectory(rootDir, {
+      maxDepth: 3,
+    });
+    assert(findFileByName(files, 'img'));
+    assert(findFileByName(files, 'logo.png') === undefined);
+  });
+
   test('should correctly list directory when sort', async () => {
     const files = await listDirectory(rootDir, {
       sort: true,
@@ -55,14 +63,6 @@ suite('lib/directory functions', function () {
     ]);
   });
 
-  test('should correctly list directories when recursively into depth 3', async () => {
-    const files = await listDirectory(rootDir, {
-      maxDepth: 3,
-    });
-    assert(findFileByName(files, 'img'));
-    assert(findFileByName(files, 'logo.png') === undefined);
-  });
-
   test('should correctly format file tree items', async () => {
     const fileItems = await formatFileTreeItemsFromDirectory(rootDir, {
       maxDepth: Number.MAX_VALUE,

src/utils.ts

@@ -115,8 +115,8 @@ export function getCharCodesFromConfig(): ICharset {
   if (isInTestMode) {
     return defaultCharset;
   }
-  const config: IVsCodeConfig = getConfig();
-  const charset: ICharset = {
+  const config = getConfig();
+  const charset = {
     root: validateCharCode(config.rootCharCode, defaultCharset.root),
     child: validateCharCode(config.childCharCode, defaultCharset.child),
     last: validateCharCode(config.lastCharCode, defaultCharset.last),
@@ -135,6 +135,14 @@ export function getDirectoryIgnoreFromConfig(): string[] {
   return defaultDirectoryIgnore;
 }
 
+export function getDirectoryMaxDepthFromConfig(): number {
+  const { directoryMaxDepth } = getConfig();
+  if (directoryMaxDepth === 0 || !Number.isInteger(directoryMaxDepth)) {
+    return Number.MAX_SAFE_INTEGER;
+  }
+  return directoryMaxDepth!;
+}
+
 function validateCharCode(
   userValue: number | undefined,
   fallback: string