Make maxDepth parameter optional

Author: jguoamz

packages/core/src/codewhispererChat/tools/listDirectory.ts

@@ -12,12 +12,12 @@ import path from 'path'
 
 export interface ListDirectoryParams {
     path: string
-    maxDepth: number
+    maxDepth?: number
 }
 
 export class ListDirectory {
     private fsPath: string
-    private maxDepth: number
+    private maxDepth?: number
     private readonly logger = getLogger('listDirectory')
 
     constructor(params: ListDirectoryParams) {
@@ -47,10 +47,13 @@ export class ListDirectory {
 
     public queueDescription(updates: Writable): void {
         const fileName = path.basename(this.fsPath)
-        if (this.maxDepth === -1) {
+        if (this.maxDepth === undefined) {
             updates.write(`Listing directory recursively: ${fileName}`)
+        } else if (this.maxDepth === 0) {
+            updates.write(`Listing directory: ${fileName}`)
         } else {
-            updates.write(`Listing directory: ${fileName} with a depth of ${this.maxDepth}`)
+            const level = this.maxDepth > 1 ? 'levels' : 'level'
+            updates.write(`Listing directory: ${fileName} limited to ${this.maxDepth} subfolder ${level}`)
         }
         updates.end()
     }

packages/core/src/codewhispererChat/tools/tool_index.json

@@ -89,10 +89,10 @@
                 },
                 "maxDepth": {
                     "type": "integer",
-                    "description": "Maximum depth to traverse when listing directories. Use `0` to list only the specified directory, `1` to include immediate subdirectories, etc. Use `-1` for unlimited depth (to list all subdirectories recursively)."
+                    "description": "Maximum depth to traverse when listing directories. Use `0` to list only the specified directory, `1` to include immediate subdirectories, etc. If it's not provided, it will list all subdirectories recursively."
                 }
             },
-            "required": ["path", "maxDepth"]
+            "required": ["path"]
         }
     }
 }

packages/core/src/shared/utilities/workspaceUtils.ts

@@ -693,15 +693,16 @@ export function formatListing(name: string, fileType: vscode.FileType, fullPath:
  * You can either pass a custom callback or rely on the default `formatListing`.
  *
  * @param dirUri The folder to begin traversing
- * @param maxDepth Maximum depth to descend (0 => just this folder, -1 => unlimited depth)
+ * @param maxDepth Maximum depth to descend (0 => just this folder, if it's missing -> recursively)
  * @param customFormatCallback Optional. If given, it will override the default line-formatting
  */
 export async function readDirectoryRecursively(
     dirUri: vscode.Uri,
-    maxDepth: number,
+    maxDepth?: number,
     customFormatCallback?: (name: string, fileType: vscode.FileType, fullPath: string) => string
 ): Promise<string[]> {
     const logger = getLogger()
+    maxDepth = maxDepth ?? -1
     const depthDescription = maxDepth < 0 ? 'unlimited' : maxDepth
     logger.info(`Reading directory: ${dirUri.fsPath} to max depth: ${depthDescription}`)
 

packages/core/src/test/codewhispererChat/tools/listDirectory.test.ts

@@ -42,7 +42,7 @@ describe('ListDirectory Tool', () => {
         await testFolder.write('fileA.txt', 'fileA content')
         await testFolder.write(path.join('subfolder', 'fileB.md'), '# fileB')
 
-        const listDirectory = new ListDirectory({ path: testFolder.path, maxDepth: -1 })
+        const listDirectory = new ListDirectory({ path: testFolder.path })
         await listDirectory.validate()
         const result = await listDirectory.invoke(process.stdout)