refactor(core): rename internal core modules for clarity

Author: mcous

package.json

@@ -72,7 +72,9 @@
     "types": "svelte-check",
     "types:legacy": "svelte-check --tsconfig tsconfig.legacy.json",
     "validate": "npm-run-all test:vitest:* test:jest types build",
-    "build": "tsc -p tsconfig.build.json && cp src/component-types.d.ts types",
+    "build": "npm-run-all build:*",
+    "build:tsc": "tsc -p tsconfig.build.json",
+    "build:copy-dts": "cp src/core/types.d.ts types/core",
     "contributors:add": "all-contributors add",
     "contributors:generate": "all-contributors generate",
     "preview-release": "./scripts/preview-release",

src/__tests__/render-runes.test-d.ts

@@ -29,8 +29,9 @@ describe('types', () => {
   test('render result has container and component', () => {
     const result = subject.render(Component, { name: 'Alice', count: 42 })
 
-    expectTypeOf(result).toMatchTypeOf<{
+    expectTypeOf(result).toExtend<{
       container: HTMLElement
+      baseElement: HTMLElement
       component: { hello: string }
       debug: (el?: HTMLElement) => void
       rerender: (props: { name?: string; count?: number }) => Promise<void>
@@ -55,7 +56,7 @@ describe('legacy component types', () => {
       count: 42,
     })
 
-    expectTypeOf(component).toMatchTypeOf<{ hello: string }>()
+    expectTypeOf(component).toExtend<{ hello: string }>()
 
     // @ts-expect-error: Svelte 5 mount does not return `$set`
     component.$on('greeting', onGreeting)

src/__tests__/render-utilities.test-d.ts

@@ -8,7 +8,7 @@ describe('render query and utility types', () => {
   test('render result has default queries', () => {
     const result = subject.render(Component, { name: 'Alice' })
 
-    expectTypeOf(result.getByRole).parameters.toMatchTypeOf<
+    expectTypeOf(result.getByRole).parameters.toExtend<
       [role: subject.ByRoleMatcher, options?: subject.ByRoleOptions]
     >()
   })
@@ -27,25 +27,25 @@ describe('render query and utility types', () => {
       { queries: { getByVibes } }
     )
 
-    expectTypeOf(result.getByVibes).parameters.toMatchTypeOf<[vibes: string]>()
+    expectTypeOf(result.getByVibes).parameters.toExtend<[vibes: string]>()
   })
 
   test('act is an async function', () => {
-    expectTypeOf(subject.act).toMatchTypeOf<() => Promise<void>>()
+    expectTypeOf(subject.act).toExtend<() => Promise<void>>()
   })
 
   test('act accepts a sync function', () => {
-    expectTypeOf(subject.act).toMatchTypeOf<(fn: () => void) => Promise<void>>()
+    expectTypeOf(subject.act).toExtend<(fn: () => void) => Promise<void>>()
   })
 
   test('act accepts an async function', () => {
-    expectTypeOf(subject.act).toMatchTypeOf<
+    expectTypeOf(subject.act).toExtend<
       (fn: () => Promise<void>) => Promise<void>
     >()
   })
 
   test('fireEvent is an async function', () => {
-    expectTypeOf(subject.fireEvent).toMatchTypeOf<
+    expectTypeOf(subject.fireEvent).toExtend<
       (
         element: Element | Node | Document | Window,
         event: Event
@@ -54,7 +54,7 @@ describe('render query and utility types', () => {
   })
 
   test('fireEvent[eventName] is an async function', () => {
-    expectTypeOf(subject.fireEvent.click).toMatchTypeOf<
+    expectTypeOf(subject.fireEvent.click).toExtend<
       (
         element: Element | Node | Document | Window,
         // eslint-disable-next-line @typescript-eslint/no-empty-object-type

src/__tests__/render.test-d.ts

@@ -37,8 +37,9 @@ describe('types', () => {
   test('render result has container and component', () => {
     const result = subject.render(Component, { name: 'Alice', count: 42 })
 
-    expectTypeOf(result).toMatchTypeOf<{
+    expectTypeOf(result).toExtend<{
       container: HTMLElement
+      baseElement: HTMLElement
       component: { hello: string }
       debug: (el?: HTMLElement) => void
       rerender: (props: { name?: string; count?: number }) => Promise<void>

src/core/index.js

@@ -5,15 +5,12 @@
  * Will switch to legacy, class-based mounting logic
  * if it looks like we're in a Svelte <= 4 environment.
  */
-import * as LegacyCore from './legacy.js'
-import * as ModernCore from './modern.svelte.js'
-import {
-  createValidateOptions,
-  UnknownSvelteOptionsError,
-} from './validate-options.js'
+import * as MountLegacy from './mount-legacy.js'
+import * as MountModern from './mount-modern.svelte.js'
+import { createValidateOptions, UnknownSvelteOptionsError } from './prepare.js'
 
 const { mount, unmount, updateProps, allowedOptions } =
-  ModernCore.IS_MODERN_SVELTE ? ModernCore : LegacyCore
+  MountModern.IS_MODERN_SVELTE ? MountModern : MountLegacy
 
 /** Validate component options. */
 const validateOptions = createValidateOptions(allowedOptions)

src/core/legacy.js renamed to src/core/mount-legacy.js

@@ -13,8 +13,8 @@ const componentCache = new Set()
 /**
  * Customize how Svelte renders the component.
  *
- * @template {import('./component-types.js').Component} C
- * @typedef {import('./component-types.js').Props<C> | Partial<import('./component-types.js').MountOptions<C>>} SvelteComponentOptions
+ * @template {import('./core/types.js').Component} C
+ * @typedef {import('./core/types.js').Props<C> | Partial<import('./core/types.js').MountOptions<C>>} SvelteComponentOptions
  */
 
 /**
@@ -30,15 +30,15 @@ const componentCache = new Set()
 /**
  * The rendered component and bound testing functions.
  *
- * @template {import('./component-types.js').Component} C
+ * @template {import('./core/types.js').Component} C
  * @template {import('@testing-library/dom').Queries} [Q=typeof import('@testing-library/dom').queries]
  *
  * @typedef {{
  *   container: HTMLElement
  *   baseElement: HTMLElement
- *   component: import('./component-types.js').Exports<C>
+ *   component: import('./core/types.js').Exports<C>
  *   debug: (el?: HTMLElement | DocumentFragment) => void
- *   rerender: (props: Partial<import('./component-types.js').Props<C>>) => Promise<void>
+ *   rerender: (props: Partial<import('./core/types.js').Props<C>>) => Promise<void>
  *   unmount: () => void
  * } & {
  *   [P in keyof Q]: import('@testing-library/dom').BoundFunction<Q[P]>
@@ -48,10 +48,10 @@ const componentCache = new Set()
 /**
  * Render a component into the document.
  *
- * @template {import('./component-types.js').Component} C
+ * @template {import('./core/types.js').Component} C
  * @template {import('@testing-library/dom').Queries} [Q=typeof import('@testing-library/dom').queries]
  *
- * @param {import('./component-types.js').ComponentType<C>} Component - The component to render.
+ * @param {import('./core/types.js').ComponentType<C>} Component - The component to render.
  * @param {SvelteComponentOptions<C>} options - Customize how Svelte renders the component.
  * @param {RenderOptions<Q>} renderOptions - Customize how Testing Library sets up the document and binds queries.
  * @returns {RenderResult<C, Q>} The rendered component and bound testing functions.