expect-webdriverio: revert breaking change

webdriverio · Feb 12, 2024 · 87a4b0a · 87a4b0a
1 parent 3a54956
commit 87a4b0a
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 87 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -1,24 +1,13 @@
 /// <reference types="../types/standalone.d.ts" />
 import { expect as expectLib } from 'expect'
-import type { RawMatcherFn } from './types.js'
 
 import wdioMatchers from './matchers.js'
 import { DEFAULT_OPTIONS } from './constants.js'
 
-export const matchers = new Map<string, RawMatcherFn>()
+expectLib.extend({ ...wdioMatchers })
 
-const extend = expectLib.extend
-expectLib.extend = (m) => {
-    if (!m || typeof m !== 'object') {
-        return
-    }
-
-    Object.entries(m).forEach(([name, matcher]) => matchers.set(name, matcher))
-    return extend(m)
-}
-
-expectLib.extend(wdioMatchers)
 export const expect = expectLib as unknown as ExpectWebdriverIO.Expect
+export const matchers = wdioMatchers
 export const getConfig = (): any => DEFAULT_OPTIONS
 export const setDefaultOptions = (options = {}): void => {
     Object.entries(options).forEach(([key, value]) => {

diff --git a/src/types.ts b/src/types.ts
@@ -1,9 +1,3 @@
-import type { ExpectationResult, MatcherContext } from 'expect'
-
 export type WdioElementMaybePromise =
     WebdriverIO.Element | WebdriverIO.ElementArray |
     Promise<WebdriverIO.Element> | Promise<WebdriverIO.ElementArray>
-
-export type RawMatcherFn<Context extends MatcherContext = MatcherContext> = {
-    (this: Context, actual: any, ...expected: Array<any>): ExpectationResult;
-}
diff --git a/test/matchers.test.ts b/test/matchers.test.ts
@@ -1,74 +1,64 @@
-import { test, expect, vi } from 'vitest'
-import { matchers, expect as expectLib } from '../src/index.js'
+import { test, expect } from 'vitest'
+import Matchers from '../src/matchers.js'
 
-const ALL_MATCHERS = [
-    // browser
-    'toHaveClipboardText',
-    'toHaveClipboardTextContaining',
-    'toHaveTitle',
-    'toHaveTitleContaining',
-    'toHaveUrl',
-    'toHaveUrlContaining',
-
-    // elements
-    'toBeElementsArrayOfSize',
-
-    // elements
-    'toBeClickable',
-    'toBeDisabled',
-    'toBeDisplayed',
-    'toBeDisplayedInViewport',
-    'toBeEnabled',
-    'toExist',
-    'toBeExisting',
-    'toBePresent',
-    'toBeFocused',
-    'toBeSelected',
-    'toBeChecked',
-    'toHaveAttributeAndValue',
-    'toHaveAttribute',
-    'toHaveAttributeContaining',
-    'toHaveAttrContaining',
-    'toHaveAttr',
-    'toHaveChildren',
-    'toHaveClass',
-    'toHaveElementClass',
-    'toHaveElementClassContaining',
-    'toHaveClassContaining',
-    'toHaveHref',
-    'toHaveLink',
-    'toHaveHrefContaining',
-    'toHaveLinkContaining',
-    'toHaveHTML',
-    'toHaveHTMLContaining',
-    'toHaveId',
-    'toHaveSize',
-    'toHaveElementProperty',
-    'toHaveText',
-    'toHaveTextContaining',
-    'toHaveValue',
-    'toHaveValueContaining',
-    'toHaveStyle',
+test('matchers', () => {
+    expect(Object.keys(Matchers)).toEqual([
+        // browser
+        'toHaveClipboardText',
+        'toHaveClipboardTextContaining',
+        'toHaveTitle',
+        'toHaveTitleContaining',
+        'toHaveUrl',
+        'toHaveUrlContaining',
 
-    // mock
-    'toBeRequested',
-    'toBeRequestedTimes',
-    'toBeRequestedWith',
-    'toBeRequestedWithResponse',
+        // elements
+        'toBeElementsArrayOfSize',
 
-    // snapshot
-    'toMatchSnapshot',
-    'toMatchInlineSnapshot'
-]
+        // elements
+        'toBeClickable',
+        'toBeDisabled',
+        'toBeDisplayed',
+        'toBeDisplayedInViewport',
+        'toBeEnabled',
+        'toExist',
+        'toBeExisting',
+        'toBePresent',
+        'toBeFocused',
+        'toBeSelected',
+        'toBeChecked',
+        'toHaveAttributeAndValue',
+        'toHaveAttribute',
+        'toHaveAttributeContaining',
+        'toHaveAttrContaining',
+        'toHaveAttr',
+        'toHaveChildren',
+        'toHaveClass',
+        'toHaveElementClass',
+        'toHaveElementClassContaining',
+        'toHaveClassContaining',
+        'toHaveHref',
+        'toHaveLink',
+        'toHaveHrefContaining',
+        'toHaveLinkContaining',
+        'toHaveHTML',
+        'toHaveHTMLContaining',
+        'toHaveId',
+        'toHaveSize',
+        'toHaveElementProperty',
+        'toHaveText',
+        'toHaveTextContaining',
+        'toHaveValue',
+        'toHaveValueContaining',
+        'toHaveStyle',
 
-test('matchers', () => {
-    expect([...matchers.keys()]).toEqual(ALL_MATCHERS)
-})
+        // mock
+        'toBeRequested',
+        'toBeRequestedTimes',
+        'toBeRequestedWith',
+        'toBeRequestedWithResponse',
 
-test('allows to add matcher', () => {
-    const matcher: any = vi.fn((actual: any, expected: any) => ({ pass: actual === expected }))
-    expectLib.extend({ toBeCustom: matcher })
-    // @ts-expect-error not in types
-    expectLib('foo').toBeCustom('foo')
-    expect(matchers.keys()).toContain('toBeCustom')
+        // snapshot
+        'toMatchSnapshot',
+        'toMatchInlineSnapshot'
+    ])
 })