refactor(util): allow search depth to be 0

Signed-off-by: Lexus Drumgold <[email protected]>

.commitlintrc.ts

@@ -15,7 +15,10 @@ import { scopes } from '@flex-development/commitlint-config'
 const config: UserConfig = {
   extends: ['@flex-development'],
   rules: {
-    'scope-enum': [RuleConfigSeverity.Error, 'always', scopes(['chore'])]
+    'scope-enum': [RuleConfigSeverity.Error, 'always', scopes([
+      'chore',
+      'util'
+    ])]
   }
 }
 

README.md

@@ -99,15 +99,23 @@ Options for creating a file system tree (TypeScript interface).
 
 #### Properties
 
-- `content` (`boolean`, optional) — include file content (populates the `value` field of each [`file` node][fst-file])
-- `depth` (`number`, optional) — maximum search depth (inclusive)
-- `extensions` ([`Extensions`](#extensions), optional) — list of file extensions to filter matched files by
-- `filters` ([`Filters`](#filters), optional) — path filters to determine if nodes should be added to the tree
-- `fs` ([`Partial<FileSystem>`](#filesystem), optional) — file system adapter
-- `handles` ([`Handles`](#handles), optional) — node handlers
-- `root` (`URL | string`, optional) — module id of root directory
+- `content` (`boolean`, optional) —
+  include file content (populates the `value` field of each [`file` node][fst-file])
+- `depth` (`number`, optional) —
+  maximum search depth (inclusive). a search depth less than `0` will produce an empty tree
+- `extensions` ([`Extensions`](#extensions), optional) —
+  list of file extensions to filter matched files by
+- `filters` ([`Filters`](#filters), optional) —
+  path filters to determine if nodes should be added to the tree
+- `fs` ([`Partial<FileSystem>`](#filesystem), optional) —
+  file system adapter
+- `handles` ([`Handles`](#handles), optional) —
+  node handlers
+- `root` (`URL | string`, optional) —
+  module id of root directory
   - **default**: [`pathe.cwd() + pathe.sep`][pathe]
-- `sort` ([`Sort`](#sort), optional) — function used to sort child nodes
+- `sort` ([`Sort`](#sort), optional) —
+  function used to sort child nodes
 
 ### `Dirent`
 

__tests__/utils/readdir.mts

@@ -49,7 +49,7 @@ function readdir(
   if (
     depth === null ||
     depth === undefined ||
-    typeof depth === 'number' && depth > 0
+    typeof depth === 'number' && depth >= 0
   ) {
     dir = toPath(dir)
 

src/__tests__/util.spec.mts

@@ -84,12 +84,9 @@ describe('unit:fromFileSystem', () => {
     }
   })
 
-  it.each<Parameters<typeof testSubject>>([
-    [{ depth: -13 }],
-    [{ depth: 0 }]
-  ])('should return empty tree (%#)', options => {
+  it('should return empty tree', () => {
     // Act
-    const result = testSubject(options)
+    const result = testSubject({ depth: -13 })
 
     // Expect
     expect(result).to.have.property('children').be.an('array')
@@ -104,14 +101,14 @@ describe('unit:fromFileSystem', () => {
   ]>([
     [
       {
-        depth: 1
+        depth: 0
       },
       function assertion(
         this: void,
         options: Options | null | undefined
       ): Fn<[Root], undefined> {
         ok(options, 'expected `options`')
-        ok(options.depth, 'expected `options.depth`')
+        ok(typeof options.depth === 'number', 'expected `options.depth`')
 
         /**
          * Read directory result.

src/interfaces/options.mts

@@ -24,6 +24,8 @@ interface Options {
 
   /**
    * Maximum search depth (inclusive).
+   *
+   * > 👉 **Note**: A search depth less than `0` will produce an empty tree.
    */
   depth?: number | null | undefined
 

src/util.mts

@@ -135,7 +135,7 @@ function fromFileSystem(
     if (
       depth === null ||
       depth === undefined ||
-      typeof depth === 'number' && depth > 0
+      typeof depth === 'number' && depth >= 0
     ) {
       for (const dirent of fs.readdirSync(path, { withFileTypes: true })) {
         /**