feat(interfaces): ParseConfigHost

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

Author: unicornware

README.md

@@ -100,6 +100,7 @@ This package is fully typed with [TypeScript][].
 - [`FileSystem`](./src/interfaces/file-system.mts)
 - [`LoadTsconfigOptions`](./src/interfaces/options-load-tsconfig.mts)
 - [`ModuleResolutionHost`](./src/interfaces/host-module-resolution.mts)
+- [`ParseConfigHost`](./src/interfaces/host-parse-config.mts)
 - [`ReadTsconfigOptions`](./src/interfaces/options-read-tsconfig.mts)
 - [`ResolvePathOptions`](./src/interfaces/options-resolve-path.mts)
 - [`ResolvedTsconfig`](./src/interfaces/options-resolve-path.mts)

__tests__/reporters/verbose.mts

@@ -7,21 +7,9 @@
 import type { Task, TaskResultPack } from '@vitest/runner'
 import { getNames, getTests } from '@vitest/runner/utils'
 import colors, { type Colors } from 'tinyrainbow'
-import type { RunnerTask } from 'vitest'
+import type { RunnerTask, RunnerTestFile } from 'vitest'
 import { DefaultReporter, type Reporter } from 'vitest/reporters'
 
-/**
- * Verbose reporter options.
- */
-interface Options {
-  /**
-   * Enable summary reporter?
-   *
-   * @default true
-   */
-  summary?: boolean | null | undefined
-}
-
 /**
  * Verbose reporter.
  *
@@ -43,13 +31,12 @@ class VerboseReporter extends DefaultReporter implements Reporter {
 
   /**
    * Create a new verbose reporter.
-   *
-   * @param {Options | null | undefined} [options]
-   *  Reporter options
    */
-  constructor(options?: Options | null | undefined) {
-    super({ summary: options?.summary ?? true })
+  constructor() {
+    super({ summary: true })
+
     this.colors = colors
+    this.renderSucceed = true
     this.verbose = true
   }
 
@@ -113,6 +100,29 @@ class VerboseReporter extends DefaultReporter implements Reporter {
   /**
    * Print tasks.
    *
+   * @see {@linkcode RunnerTestFile}
+   *
+   * @public
+   * @override
+   * @instance
+   *
+   * @param {RunnerTestFile[] | undefined} [files]
+   *  List of test files
+   * @param {unknown[] | undefined} [errors]
+   *  List of unhandled errors
+   * @return {undefined}
+   */
+  public override onFinished(
+    files?: RunnerTestFile[] | undefined,
+    errors?: unknown[] | undefined
+  ): undefined {
+    if (files) { for (const task of files) this.printTask(task, true) }
+    return void super.onFinished(files, errors)
+  }
+
+  /**
+   * Handle task updates.
+   *
    * @see {@linkcode TaskResultPack}
    *
    * @public
@@ -124,21 +134,7 @@ class VerboseReporter extends DefaultReporter implements Reporter {
    * @return {undefined}
    */
   public override onTaskUpdate(packs: TaskResultPack[]): undefined {
-    for (const pack of packs) {
-      /**
-       * Current task.
-       *
-       * @const {Task | undefined} task
-       */
-      const task: Task | undefined = this.ctx.state.idMap.get(pack[0])
-
-      // print top-level suite task and recursively print tests
-      if (task && task.type === 'suite' && 'filepath' in task) {
-        void this.printTask(task)
-      }
-    }
-
-    return void packs
+    return void (this.isTTY && void super.onTaskUpdate(packs))
   }
 
   /**
@@ -152,10 +148,20 @@ class VerboseReporter extends DefaultReporter implements Reporter {
    *
    * @param {Task | null | undefined} task
    *  The task to handle
+   * @param {boolean | null | undefined} [force]
+   *  Print `task` even when {@linkcode isTTY} is `false`?
    * @return {undefined}
    */
-  protected override printTask(task: Task | null | undefined): undefined {
-    if (task && task.result?.state !== 'run') {
+  protected override printTask(
+    task: Task | null | undefined,
+    force?: boolean | null | undefined
+  ): undefined {
+    if (
+      (!this.isTTY || force) &&
+      task?.result?.state &&
+      task.result.state !== 'queued' &&
+      task.result.state !== 'run'
+    ) {
       /**
        * Task skipped?
        *
@@ -197,7 +203,10 @@ class VerboseReporter extends DefaultReporter implements Reporter {
         state += skip ? this.colors.blackBright(suite) : suite
 
         this.log(state)
-        if (!skip) { for (const tsk of task.tasks) void this.printTask(tsk) }
+
+        if (!skip) {
+          for (const subtask of task.tasks) void this.printTask(subtask, force)
+        }
       }
     }
 

src/interfaces/__tests__/host-parse-config.spec-d.mts

@@ -0,0 +1,52 @@
+/**
+ * @file Type Tests - ParseConfigHost
+ * @module tsconfig-utils/interfaces/tests/unit-d/ParseConfigHost
+ */
+
+import type TestSubject from '#interfaces/host-parse-config'
+import type { ModuleId } from '@flex-development/mlly'
+import type { ModuleResolutionHost } from '@flex-development/tsconfig-utils'
+import type ts from 'typescript'
+
+describe('unit-d:interfaces/ParseConfigHost', () => {
+  it('should extend ModuleResolutionHost', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<ModuleResolutionHost>()
+  })
+
+  it('should match [useCaseSensitiveFileNames: boolean]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('useCaseSensitiveFileNames')
+      .toEqualTypeOf<boolean>
+  })
+
+  it('should match Required<Omit<ts.ParseConfigHost, "trace">>', () => {
+    expectTypeOf<TestSubject>()
+      .toMatchTypeOf<Required<Omit<ts.ParseConfigHost, 'trace'>>>()
+  })
+
+  describe('readDirectory', () => {
+    type Subject = TestSubject['readDirectory']
+
+    it('should match [this: void]', () => {
+      expectTypeOf<Subject>().thisParameter.toEqualTypeOf<void>()
+    })
+
+    describe('parameters', () => {
+      it('should be callable with [ModuleId, Set<string> | readonly string[] | undefined, Set<string> | readonly string[] | undefined, Set<string> | readonly string[] | undefined, number | null | undefined]', () => {
+        expectTypeOf<Subject>().parameters.toEqualTypeOf<[
+          ModuleId,
+          (Set<string> | readonly string[] | undefined)?,
+          (Set<string> | readonly string[] | undefined)?,
+          (Set<string> | readonly string[] | undefined)?,
+          (number | null | undefined)?
+        ]>()
+      })
+    })
+
+    describe('returns', () => {
+      it('should return readonly string[]', () => {
+        expectTypeOf<Subject>().returns.toEqualTypeOf<readonly string[]>()
+      })
+    })
+  })
+})

src/interfaces/host-parse-config.mts

@@ -0,0 +1,56 @@
+/**
+ * @file Interfaces - ModuleResolutionHost
+ * @module tsconfig-utils/interfaces/ModuleResolutionHost
+ */
+
+import type { ModuleId } from '@flex-development/mlly'
+import type { ModuleResolutionHost } from '@flex-development/tsconfig-utils'
+
+/**
+ * Configuration parser host API.
+ *
+ * Provides methods for accessing the file system and resolving module paths.
+ *
+ * @see {@linkcode ModuleResolutionHost}
+ *
+ * @extends {ModuleResolutionHost}
+ */
+interface ParseConfigHost extends ModuleResolutionHost {
+  /**
+   * Get a list of files in a directory.
+   *
+   * @see {@linkcode ModuleId}
+   *
+   * @this {void}
+   *
+   * @param {ModuleId} id
+   *  The directory path or URL to read
+   * @param {Set<string> | ReadonlyArray<string> | undefined} [extensions]
+   *  List of file extensions to filter for
+   * @param {Set<string> | ReadonlyArray<string> | undefined} [exclude]
+   *  List of of glob patterns matching files to exclude
+   * @param {Set<string> | ReadonlyArray<string> | undefined} [include]
+   *  List of of glob patterns matching files to include
+   * @param {number | null | undefined} [depth]
+   *  Maximum search depth (inclusive)
+   * @return {ReadonlyArray<string>}
+   *  List of files under directory at `id`
+   */
+  readDirectory(
+    this: void,
+    id: ModuleId,
+    extensions?: Set<string> | readonly string[] | undefined,
+    exclude?: Set<string> | readonly string[] | undefined,
+    include?: Set<string> | readonly string[] | undefined,
+    depth?: number | null | undefined
+  ): readonly string[]
+
+  /**
+   * Treat filenames as case-sensitive?
+   *
+   * @override
+   */
+  useCaseSensitiveFileNames: boolean
+}
+
+export type { ParseConfigHost as default }

src/interfaces/index.mts

@@ -7,6 +7,7 @@ export type { default as FileSystem } from '#interfaces/file-system'
 export type {
   default as ModuleResolutionHost
 } from '#interfaces/host-module-resolution'
+export type { default as ParseConfigHost } from '#interfaces/host-parse-config'
 export type {
   default as LoadTsconfigOptions
 } from '#interfaces/options-load-tsconfig'

vitest.config.mts

@@ -118,9 +118,9 @@ function config(env: ConfigEnv): ViteUserConfig {
            * @async
            *
            * @param {TestSpecification[]} specs
-           *  Workspace spec objects
+           *  List of test file specifications
            * @return {Promise<TestSpecification[]>}
-           *  Sorted `specs`
+           *  Sorted test files
            */
           public override async sort(
             specs: TestSpecification[]