Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions packages/svelte-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"exports": {
".": {
"types": "./dist/index.d.ts",
"svelte": "./src/index.js",
"default": "./src/index.js"
},
"./types": {
Expand All @@ -27,16 +26,12 @@
"node": ">=16"
},
"keywords": [
"testing",
"tdd",
"svelte",
"ui",
"dom",
"jsdom",
"unit",
"integration",
"functional",
"end-to-end",
"e2e"
"component",
"functional"
],
"files": [
"dist",
Expand Down
4 changes: 4 additions & 0 deletions packages/svelte/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
"types": "./dist/index.d.ts",
"default": "./src/index.js"
},
"./pure": {
"types": "./dist/pure.d.ts",
"default": "./src/pure.js"
},
"./svelte5": {
"types": "./dist/index.d.ts",
"default": "./src/index.js"
Expand Down
13 changes: 1 addition & 12 deletions packages/svelte/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,4 @@ if (typeof process !== 'undefined' && !process.env.STL_SKIP_AUTO_CLEANUP) {
}
}

// export all base queries, screen, etc.
export * from '@testing-library/dom'

// export svelte-specific functions and custom `fireEvent`
export {
act,
cleanup,
fireEvent,
render,
setup,
UnknownSvelteOptionsError,
} from './pure.js'
export * from './pure.js'
52 changes: 26 additions & 26 deletions packages/svelte/src/pure.js
Original file line number Diff line number Diff line change
@@ -1,35 +1,27 @@
import {
configure as configureDTL,
fireEvent as baseFireEvent,
getConfig as getDTLConfig,
getQueriesForElement,
prettyDOM,
} from '@testing-library/dom'
import * as DomTestingLibrary from '@testing-library/dom'
import * as Core from '@testing-library/svelte-core'
import * as Svelte from 'svelte'

/**
* Customize how Svelte renders the component.
*
* @deprecated Use `import('@testing-library/svelte-core/types').ComponentOptions` instead
* @template {import('@testing-library/svelte-core/types').Component} C
* @typedef {import('@testing-library/svelte-core/types').ComponentOptions<C>} SvelteComponentOptions
*/

/**
* Customize how Testing Library sets up the document and binds queries.
*
* @template {import('@testing-library/dom').Queries} [Q=typeof import('@testing-library/dom').queries]
* @typedef {{
* baseElement?: HTMLElement
* queries?: Q
* }} RenderOptions
* @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
* @typedef {import('@testing-library/svelte-core/types').SetupOptions & { queries?: Q }} RenderOptions
*/

/**
* The rendered component and bound testing functions.
*
* @template {import('@testing-library/svelte-core/types').Component} C
* @template {import('@testing-library/dom').Queries} [Q=typeof import('@testing-library/dom').queries]
* @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
*
* @typedef {{
* container: HTMLElement
Expand All @@ -39,18 +31,18 @@ import * as Svelte from 'svelte'
* rerender: import('@testing-library/svelte-core/types').Rerender<C>
* unmount: () => void
* } & {
* [P in keyof Q]: import('@testing-library/dom').BoundFunction<Q[P]>
* [P in keyof Q]: DomTestingLibrary.BoundFunction<Q[P]>
* }} RenderResult
*/

/**
* Render a component into the document.
*
* @template {import('@testing-library/svelte-core/types').Component} C
* @template {import('@testing-library/dom').Queries} [Q=typeof import('@testing-library/dom').queries]
* @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
*
* @param {import('@testing-library/svelte-core/types').ComponentImport<C>} Component - The component to render.
* @param {SvelteComponentOptions<C>} options - Customize how Svelte renders the component.
* @param {import('@testing-library/svelte-core/types').ComponentOptions<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.
*/
Expand All @@ -61,14 +53,19 @@ const render = (Component, options = {}, renderOptions = {}) => {
renderOptions
)

const queries = DomTestingLibrary.getQueriesForElement(
baseElement,
renderOptions.queries
)

return {
baseElement,
container,
component,
rerender,
unmount,
debug: (el = baseElement) => console.log(prettyDOM(el)),
...getQueriesForElement(baseElement, renderOptions.queries),
debug: (el = baseElement) => console.log(DomTestingLibrary.prettyDOM(el)),
...queries,
}
}

Expand All @@ -80,15 +77,15 @@ const render = (Component, options = {}, renderOptions = {}) => {
* to flush changes to the DOM before proceeding.
*/
const setup = () => {
const originalDTLConfig = getDTLConfig()
const originalConfig = DomTestingLibrary.getConfig()

configureDTL({
DomTestingLibrary.configure({
asyncWrapper: act,
eventWrapper: Svelte.flushSync ?? ((cb) => cb()),
})

Core.addCleanupTask(() => {
configureDTL(originalDTLConfig)
DomTestingLibrary.configure(originalConfig)
})
}

Expand All @@ -101,7 +98,7 @@ const cleanup = () => {
* Call a function and wait for Svelte to flush pending changes.
*
* @template T
* @param {(() => Promise<T>) | () => T} [fn] - A function, which may be `async`, to call before flushing updates.
* @param {() => Promise<T> | T} [fn] - A function, which may be `async`, to call before flushing updates.
* @returns {Promise<T>}
*/
const act = async (fn) => {
Expand All @@ -114,12 +111,12 @@ const act = async (fn) => {
}

/**
* @typedef {(...args: Parameters<import('@testing-library/dom').FireFunction>) => Promise<ReturnType<import('@testing-library/dom').FireFunction>>} FireFunction
* @typedef {(...args: Parameters<DomTestingLibrary.FireFunction>) => Promise<ReturnType<DomTestingLibrary.FireFunction>>} FireFunction
*/

/**
* @typedef {{
* [K in import('@testing-library/dom').EventType]: (...args: Parameters<import('@testing-library/dom').FireObject[K]>) => Promise<ReturnType<import('@testing-library/dom').FireObject[K]>>
* [K in DomTestingLibrary.EventType]: (...args: Parameters<DomTestingLibrary.FireObject[K]>) => Promise<ReturnType<DomTestingLibrary.FireObject[K]>>
* }} FireObject
*/

Expand All @@ -131,11 +128,14 @@ const act = async (fn) => {
*
* @type {FireFunction & FireObject}
*/
const fireEvent = async (...args) => act(() => baseFireEvent(...args))
const fireEvent = async (...args) => {
return act(() => DomTestingLibrary.fireEvent(...args))
}

for (const [key, baseEvent] of Object.entries(baseFireEvent)) {
for (const [key, baseEvent] of Object.entries(DomTestingLibrary.fireEvent)) {
fireEvent[key] = async (...args) => act(() => baseEvent(...args))
}

export * from '@testing-library/dom'
export { UnknownSvelteOptionsError } from '@testing-library/svelte-core'
export { act, cleanup, fireEvent, render, setup }