webdriverio/webdriverio

[馃悰 Bug]: Typescript support for Custom matchers seems broken with V9

Open

#13387 opened on Aug 18, 2024

View on GitHub
聽(2 comments)聽(0 reactions)聽(0 assignees)JavaScript聽(6,029 stars)聽(1,793 forks)batch import
Bug 馃悰help wanted

Description

Have you read the Contributing Guidelines on issues?

WebdriverIO Version

V9

Node.js Version

20

Mode

WDIO Testrunner

Which capabilities are you using?

No response

What happened?

When creating a new customer matcher and you want to use ExpectWebdriverIO.PartialMatcher you get a TS error Namespace 'global.ExpectWebdriverIO' has no exported member 'PartialMatcher'. This prevents the Visual Testing Service to upgrade to V9 without using a workaround. See also https://github.com/webdriverio/visual-testing/actions/runs/10442443274/job/28914748091?pr=417

What is your expected behavior?

No response

How to reproduce the bug.

Clone the Visual project and use this PR

Relevant log output

Namespace 'global.ExpectWebdriverIO' has no exported member 'PartialMatcher'

Code of Conduct

  • I agree to follow this project's Code of Conduct

Is there an existing issue for this?

  • I have searched the existing issues

Contributor guide

Tech stack
typescriptnodejs
Domain
testing
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript knowledgeUnderstanding of WebdriverIO custom matchers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the type definitions in the @wdio/expect package. The error indicates that `PartialMatcher` is not exported from the `ExpectWebdriverIO` namespace. Check the linked PR (webdriverio/visual testing#417) for reproduction steps. Look into the type declaration files in the repository, especially those related to expect and matchers, to find where the export should be added.