(feat): keep track of registered matchers

src/index.ts

@@ -1,12 +1,24 @@
 /// <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'
 
-expectLib.extend({ ...wdioMatchers })
+export const matchers = new Map<string, RawMatcherFn>()
+
+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]) => {

src/types.ts

@@ -1,3 +1,9 @@
+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;
+}

test/matchers.test.ts

@@ -1,64 +1,74 @@
-import { test, expect } from 'vitest'
-import Matchers from '../src/matchers.js'
+import { test, expect, vi } from 'vitest'
+import { matchers, expect as expectLib } from '../src/index.js'
 
-test('matchers', () => {
-    expect(Object.keys(Matchers)).toEqual([
-        // browser
-        'toHaveClipboardText',
-        'toHaveClipboardTextContaining',
-        'toHaveTitle',
-        'toHaveTitleContaining',
-        'toHaveUrl',
-        'toHaveUrlContaining',
+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',
 
-        // elements
-        'toBeElementsArrayOfSize',
+    // mock
+    'toBeRequested',
+    'toBeRequestedTimes',
+    'toBeRequestedWith',
+    'toBeRequestedWithResponse',
 
-        // 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',
+    // snapshot
+    'toMatchSnapshot',
+    'toMatchInlineSnapshot'
+]
 
-        // mock
-        'toBeRequested',
-        'toBeRequestedTimes',
-        'toBeRequestedWith',
-        'toBeRequestedWithResponse',
+test('matchers', () => {
+    expect([...matchers.keys()]).toEqual(ALL_MATCHERS)
+})
 
-        // snapshot
-        'toMatchSnapshot',
-        'toMatchInlineSnapshot'
-    ])
+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')
 })