refactor(lib): [createModuleResolutionHost] implement host options

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

Author: unicornware

README.md

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

src/interfaces/__tests__/options-module-resolution-host.spec-d.mts

@@ -0,0 +1,33 @@
+/**
+ * @file Type Tests - ModuleResolutionHostOptions
+ * @module tsconfig-utils/interfaces/tests/unit-d/ModuleResolutionHostOptions
+ */
+
+import type TestSubject from '#interfaces/options-module-resolution-host'
+import type { ModuleId } from '@flex-development/mlly'
+import type { FileSystem } from '@flex-development/tsconfig-utils'
+import type { Nilable } from '@flex-development/tutils'
+
+describe('unit-d:interfaces/ModuleResolutionHostOptions', () => {
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should match [fs?: FileSystem | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('fs')
+      .toEqualTypeOf<Nilable<FileSystem>>()
+  })
+
+  it('should match [root?: ModuleId | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('root')
+      .toEqualTypeOf<Nilable<ModuleId>>()
+  })
+
+  it('should match [useCaseSensitiveFileNames?: ((this: void) => boolean) | boolean | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('root')
+      .toEqualTypeOf<Nilable<ModuleId>>()
+  })
+})

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

@@ -0,0 +1,19 @@
+/**
+ * @file Type Tests - ParseConfigHostOptions
+ * @module tsconfig-utils/interfaces/tests/unit-d/ParseConfigHostOptions
+ */
+
+import type TestSubject from '#interfaces/options-parse-config-host'
+import type {
+  ModuleResolutionHostOptions
+} from '@flex-development/tsconfig-utils'
+
+describe('unit-d:interfaces/ParseConfigHostOptions', () => {
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should extend ModuleResolutionHostOptions', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<ModuleResolutionHostOptions>()
+  })
+})

src/interfaces/file-system.mts

@@ -45,7 +45,7 @@ interface FileSystem extends mlly.FileSystem {
   readdir(this: void, id: mlly.ModuleId): string[]
 
   /**
-   * Get the canonical pathname of `id`.
+   * Get the resolved pathname of `id`.
    *
    * @see {@linkcode mlly.ModuleId}
    *

src/interfaces/host-module-resolution.mts

@@ -79,7 +79,7 @@ interface ModuleResolutionHost {
   readFile(this: void, id: ModuleId): string | undefined
 
   /**
-   * Get the canonical pathname of `id`.
+   * Get the resolved pathname of `id`.
    *
    * @see {@linkcode ModuleId}
    *

src/interfaces/index.mts

@@ -11,6 +11,12 @@ export type { default as ParseConfigHost } from '#interfaces/host-parse-config'
 export type {
   default as LoadTsconfigOptions
 } from '#interfaces/options-load-tsconfig'
+export type {
+  default as ModuleResolutionHostOptions
+} from '#interfaces/options-module-resolution-host'
+export type {
+  default as ParseConfigHostOptions
+} from '#interfaces/options-parse-config-host'
 export type {
   default as ReadTsconfigOptions
 } from '#interfaces/options-read-tsconfig'

src/interfaces/options-module-resolution-host.mts

@@ -0,0 +1,40 @@
+/**
+ * @file Interfaces - ModuleResolutionHostOptions
+ * @module tsconfig-utils/interfaces/ModuleResolutionHostOptions
+ */
+
+import type { ModuleId } from '@flex-development/mlly'
+import type { FileSystem } from '@flex-development/tsconfig-utils'
+
+/**
+ * Options for creating module resolution hosts.
+ */
+interface ModuleResolutionHostOptions {
+  /**
+   * File system API.
+   *
+   * @see {@linkcode FileSystem}
+   */
+  fs?: FileSystem | null | undefined
+
+  /**
+   * Module id of root directory.
+   *
+   * @see {@linkcode ModuleId}
+   *
+   * @default pathe.cwd()
+   */
+  root?: ModuleId | null | undefined
+
+  /**
+   * Boolean indicating filenames should be treated as case-sensitive, or a
+   * function that returns such a value.
+   */
+  useCaseSensitiveFileNames?:
+    | ((this: void) => boolean)
+    | boolean
+    | null
+    | undefined
+}
+
+export type { ModuleResolutionHostOptions as default }

src/interfaces/options-parse-config-host.mts

@@ -0,0 +1,19 @@
+/**
+ * @file Interfaces - ParseConfigHostOptions
+ * @module tsconfig-utils/interfaces/ParseConfigHostOptions
+ */
+
+import type {
+  ModuleResolutionHostOptions
+} from '@flex-development/tsconfig-utils'
+
+/**
+ * Options for creating parse config hosts.
+ *
+ * @see {@linkcode ModuleResolutionHostOptions}
+ *
+ * @extends {ModuleResolutionHostOptions}
+ */
+interface ParseConfigHostOptions extends ModuleResolutionHostOptions {}
+
+export type { ParseConfigHostOptions as default }

src/internal/fs.browser.mts

@@ -34,7 +34,7 @@ const fs: FileSystem = {
   },
 
   /**
-   * Get the canonical pathname of a directory or file.
+   * Get the resolved pathname of a directory or file.
    *
    * @return {never}
    *  Never; not implemented

src/lib/__tests__/create-module-resolution-host.spec.mts

@@ -3,6 +3,7 @@
  * @module tsconfig-utils/lib/tests/unit/createModuleResolutionHost
  */
 
+import fs from '#internal/fs'
 import testSubject from '#lib/create-module-resolution-host'
 import * as mlly from '@flex-development/mlly'
 import pathe from '@flex-development/pathe'
@@ -13,7 +14,11 @@ describe('unit:lib/createModuleResolutionHost', () => {
   let subject: ModuleResolutionHost
 
   beforeAll(() => {
-    subject = testSubject()
+    subject = testSubject({
+      fs,
+      root: mlly.cwd(),
+      useCaseSensitiveFileNames: true
+    })
   })
 
   describe('host', () => {