refactor(internal): [matchFiles] use file system tree

- `fs.readdirSync` now returns `Dirent` objects
- https://github.com/flex-development/fst

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

Author: unicornware

.gitignore

@@ -75,4 +75,5 @@ codecov
 # ------------------------------------------------------------------------------
 **/*config.*.timestamp*
 **/.temp/
+**/*.scratch.*
 **/scratch.*

README.md

@@ -105,6 +105,7 @@ convenience of TypeScript users who do not hoist packages, but may need to `impo
 
 ### Interfaces
 
+- [`Dirent`](./src/interfaces/dirent.mts)
 - [`FileSystem`](./src/interfaces/file-system.mts)
 - [`LoadTsconfigOptions`](./src/interfaces/options-load-tsconfig.mts)
 - [`ModuleResolutionHostOptions`](./src/interfaces/options-module-resolution-host.mts)

__tests__/reporters/verbose.mts

@@ -134,7 +134,7 @@ class VerboseReporter extends DefaultReporter implements Reporter {
    * @return {undefined}
    */
   public override onTaskUpdate(packs: TaskResultPack[]): undefined {
-    return void (this.isTTY && void super.onTaskUpdate(packs))
+    return void packs
   }
 
   /**

package.json

@@ -58,10 +58,7 @@
       "default": "./dist/interfaces/*.d.mts"
     },
     "#internal/fs": {
-      "types": {
-        "tsconfig-utils": "./src/internal/fs.d.mts",
-        "default": "./dist/internal/fs.d.mts"
-      },
+      "types": "./src/internal/fs.d.mts",
       "browser": {
         "tsconfig-utils": "./src/internal/fs.browser.mts",
         "default": "./dist/internal/fs.browser.mjs"
@@ -86,7 +83,7 @@
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "scripts": {
-    "build": "yarn clean:build; tsc -p tsconfig.build.json --noEmit false",
+    "build": "yarn clean:build; tsc -p tsconfig.build.json --noEmit false; trash ./dist/internal/*.d.mts && trash ./dist/{interfaces,types}/*.mjs",
     "check:ci": "yarn dedupe --check && yarn check:format && yarn check:lint && yarn check:spelling && yarn typecheck && yarn test:cov && yarn pack && yarn check:types:build && attw package.tgz && yarn clean:pack",
     "check:format": "dprint check --incremental=false",
     "check:lint": "eslint --exit-on-fatal-error --max-warnings 0 .",
@@ -125,6 +122,8 @@
   },
   "dependencies": {
     "@flex-development/errnode": "3.1.1",
+    "@flex-development/fst": "flex-development/fst#commit=9fae8b6708a1e392bb874a68aa28730fe6cefdf5",
+    "@flex-development/fst-util-from-fs": "flex-development/fst-util-from-fs#commit=e1e2279f829efeaf7357b76852b29d29da40c91e",
     "@flex-development/mlly": "1.0.0-alpha.20",
     "@flex-development/pathe": "4.0.1",
     "@flex-development/pkg-types": "4.1.0",

src/interfaces/__tests__/dirent.spec-d.mts

@@ -0,0 +1,19 @@
+/**
+ * @file Type Tests - Dirent
+ * @module tsconfig-utils/interfaces/tests/unit-d/Dirent
+ */
+
+import type TestSubject from '#interfaces/dirent'
+import type * as fst from '@flex-development/fst-util-from-fs'
+
+describe('unit-d:interfaces/Dirent', () => {
+  it('should extend fst.Dirent', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<fst.Dirent>()
+  })
+
+  it('should match [parentPath: string]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('parentPath')
+      .toEqualTypeOf<string>()
+  })
+})

src/interfaces/__tests__/file-system.spec-d.mts

@@ -5,6 +5,7 @@
 
 import type TestSubject from '#interfaces/file-system'
 import type * as mlly from '@flex-development/mlly'
+import type { Dirent } from '@flex-development/tsconfig-utils'
 
 describe('unit-d:interfaces/FileSystem', () => {
   it('should extend mlly.FileSystem', () => {
@@ -19,14 +20,16 @@ describe('unit-d:interfaces/FileSystem', () => {
     })
 
     describe('parameters', () => {
-      it('should be callable with [mlly.ModuleId]', () => {
-        expectTypeOf<Subject>().parameters.toEqualTypeOf<[mlly.ModuleId]>()
+      it('should be callable with [mlly.ModuleId, { withFileTypes: true }]', () => {
+        expectTypeOf<Subject>()
+          .parameters
+          .toEqualTypeOf<[mlly.ModuleId, { withFileTypes: true }]>()
       })
     })
 
     describe('returns', () => {
-      it('should return string[]', () => {
-        expectTypeOf<Subject>().returns.toEqualTypeOf<string[]>()
+      it('should return readonly Dirent[]', () => {
+        expectTypeOf<Subject>().returns.toEqualTypeOf<readonly Dirent[]>()
       })
     })
   })

src/interfaces/dirent.mts

@@ -0,0 +1,22 @@
+/**
+ * @file Interfaces - Dirent
+ * @module tsconfig-utils/interfaces/Dirent
+ */
+
+import type * as fst from '@flex-development/fst-util-from-fs'
+
+/**
+ * Directory content entry.
+ *
+ * @see {@linkcode fst.Dirent}
+ *
+ * @extends {fst.Dirent}
+ */
+interface Dirent extends fst.Dirent {
+  /**
+   * Path to parent directory.
+   */
+  parentPath: string
+}
+
+export type { Dirent as default }

src/interfaces/file-system.mts

@@ -4,6 +4,7 @@
  */
 
 import type * as mlly from '@flex-development/mlly'
+import type { Dirent } from '@flex-development/tsconfig-utils'
 
 /**
  * File system API.
@@ -14,18 +15,27 @@ import type * as mlly from '@flex-development/mlly'
  */
 interface FileSystem extends mlly.FileSystem {
   /**
-   * Read the contents of a directory.
+   * Read the contents of the directory at `id`.
    *
+   * @see {@linkcode Dirent}
    * @see {@linkcode mlly.ModuleId}
    *
    * @this {void}
    *
    * @param {mlly.ModuleId} id
-   *  The path or `file:` URL to handle
-   * @return {string[]}
-   *  List of filenames
+   *  Module id of directory to read
+   * @param {{ withFileTypes: true }} options
+   *  Read options
+   * @param {true} options.withFileTypes
+   *  Return a list of dirent objects instead of strings or `Buffer`s
+   * @return {ReadonlyArray<Dirent>}
+   *  Directory content list
    */
-  readdirSync(this: void, id: mlly.ModuleId): string[]
+  readdirSync(
+    this: void,
+    id: mlly.ModuleId,
+    options: { withFileTypes: true }
+  ): readonly Dirent[]
 }
 
 export type { FileSystem as default }

src/interfaces/index.mts

@@ -3,6 +3,7 @@
  * @module tsconfig-utils/interfaces
  */
 
+export type { default as Dirent } from '#interfaces/dirent'
 export type { default as FileSystem } from '#interfaces/file-system'
 export type {
   default as ModuleResolutionHost

src/internal/__tests__/match-files.spec.mts

@@ -6,30 +6,24 @@
 import testSubject from '#internal/match-files'
 import toPath from '#internal/to-path'
 import createModuleResolutionHost from '#lib/create-module-resolution-host'
+import type { Extensions } from '@flex-development/fst-util-from-fs'
 import * as mlly from '@flex-development/mlly'
 import type { FileSystem } from '@flex-development/tsconfig-utils'
 import { alphabetize, identity } from '@flex-development/tutils'
 import ts from 'typescript'
+import tsconfigBuild from '../../../tsconfig.build.json' with { type: 'json' }
 import tsconfig from '../../../tsconfig.json' with { type: 'json' }
 
 describe('unit:internal/matchFiles', () => {
   it.each<[
     id: mlly.ModuleId,
-    extensions: Set<string> | readonly string[] | undefined,
-    exclude: Set<string> | readonly string[] | undefined,
-    include: Set<string> | readonly string[] | undefined,
+    extensions: Extensions | null | undefined,
+    exclude: Set<string> | readonly string[] | null | undefined,
+    include: Set<string> | readonly string[] | null | undefined,
     useCaseSensitiveFileNames?: boolean | null | undefined,
     depth?: number | null | undefined,
-    fs?: FileSystem | null | undefined
+    fs?: Partial<FileSystem> | null | undefined
   ]>([
-    [
-      new URL('src', mlly.cwd()),
-      ['.cjs', '.cts', '.js', '.json', '.mjs', '.mts', '.ts'],
-      tsconfig.exclude,
-      tsconfig.include,
-      null,
-      0
-    ],
     [
       mlly.cwd(),
       ['.cjs', '.cts', '.js', '.json', '.mjs', '.mts', '.ts'],
@@ -43,8 +37,22 @@ describe('unit:internal/matchFiles', () => {
       tsconfig.include,
       undefined,
       1
+    ],
+    [
+      mlly.cwd(),
+      ['.mts'],
+      tsconfigBuild.exclude,
+      tsconfigBuild.include
+    ],
+    [
+      new URL('src', mlly.cwd()),
+      ['.cjs', '.cts', '.js', '.json', '.mjs', '.mts', '.ts'],
+      tsconfig.exclude,
+      tsconfig.include,
+      null,
+      0
     ]
-  ])('should return list of files under directory at `id` (%#)', (
+  ])('should return list of matched files (%#)', (
     id,
     extensions,
     exclude,
@@ -75,6 +83,6 @@ describe('unit:internal/matchFiles', () => {
     )
 
     // Expect
-    expect(result).to.be.an('array').and.eql(expected).and.not.be.frozen
+    expect(result).to.be.an('array').and.eql(expected).and.be.frozen
   })
 })