Skip to content

docs: Review docs before Jasmine better typing release#2129

Merged
dprevost-LMI merged 7 commits into
webdriverio:mainfrom
dprevost-LMI:review-framework-docs
Jun 29, 2026
Merged

docs: Review docs before Jasmine better typing release#2129
dprevost-LMI merged 7 commits into
webdriverio:mainfrom
dprevost-LMI:review-framework-docs

Conversation

@dprevost-LMI

Copy link
Copy Markdown
Contributor

Review Frameworks following the learnings before release enhance Jasmine support

@dprevost-LMI dprevost-LMI marked this pull request as ready for review June 28, 2026 20:45
@greptile-apps

greptile-apps Bot commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR is a documentation-focused refresh of docs/Framework.md ahead of an improved Jasmine typing release, accompanied by a minor reordering in the Mocha playground's tsconfig.json.

  • Framework.md is substantially rewritten: the Mocha section is moved ahead of Jest, the Jasmine section is expanded to clearly separate the @wdio/jasmine-framework path (using expect-webdriverio/jasmine-wdio-expect-async) from the vanilla expectAsync path, prose is tightened throughout, and missing imports are added to several code snippets.
  • playgrounds/mocha/tsconfig.json reorders the types array so the local development versions of expect-webdriverio appear before @wdio/mocha-framework and @wdio/globals/types, and replaces the previously garbled comment with clear per-entry explanations.

Confidence Score: 5/5

Safe to merge — both files are documentation and a development playground config; no runtime code is changed.

The changes are confined to documentation prose and a playground tsconfig reorder. The tsconfig reorder is correct and well-commented, and the documentation improvements are accurate. The only notable finding is an undeclared placeholder variable in one new code snippet, which does not affect any shipped code.

docs/Framework.md — the new @jest/globals Option 1 snippet references an undeclared myFunction variable that would produce a compile error if copied verbatim.

Important Files Changed

Filename Overview
docs/Framework.md Major documentation rewrite: restructures framework sections (Mocha moved before Jest, Jasmine expanded with two type-definition paths), improves phrasing throughout, and adds missing imports to code snippets. One new code snippet introduces an undeclared myFunction variable.
playgrounds/mocha/tsconfig.json Reorders types array so development-local expect-webdriverio entries appear before @wdio/mocha-framework and @wdio/globals/types, ensuring type-resolution priority for the local build; adds clear explanatory comments to each entry.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User chooses test framework] --> B{Framework}

    B --> C[Mocha]
    B --> D[Jest]
    B --> E[Jasmine]
    B --> F[Cucumber]

    C --> C1{With WDIO Testrunner?}
    C1 -->|Yes| C2[wdio/mocha-framework plug-and-play]
    C1 -->|No| C3[types/mocha + expect-webdriverio/expect-global]

    D --> D1{Ambient or explicit types?}
    D1 -->|types/jest| D2[Global ambient types - manual setup required]
    D1 -->|jest/globals| D3[Explicit imports - no tsconfig types needed]

    E --> E1{Which expect API?}
    E1 -->|wdio/jasmine-framework| E2[expect-webdriverio/jasmine-wdio-expect-async]
    E1 -->|Native expectAsync| E3[types/jasmine + expect-webdriverio/jasmine]
    E1 -->|Explicit import| E4[import wdioExpect from expect-webdriverio]

    F --> F1[wdio/cucumber-framework]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[User chooses test framework] --> B{Framework}

    B --> C[Mocha]
    B --> D[Jest]
    B --> E[Jasmine]
    B --> F[Cucumber]

    C --> C1{With WDIO Testrunner?}
    C1 -->|Yes| C2[wdio/mocha-framework plug-and-play]
    C1 -->|No| C3[types/mocha + expect-webdriverio/expect-global]

    D --> D1{Ambient or explicit types?}
    D1 -->|types/jest| D2[Global ambient types - manual setup required]
    D1 -->|jest/globals| D3[Explicit imports - no tsconfig types needed]

    E --> E1{Which expect API?}
    E1 -->|wdio/jasmine-framework| E2[expect-webdriverio/jasmine-wdio-expect-async]
    E1 -->|Native expectAsync| E3[types/jasmine + expect-webdriverio/jasmine]
    E1 -->|Explicit import| E4[import wdioExpect from expect-webdriverio]

    F --> F1[wdio/cucumber-framework]
Loading

Reviews (4): Last reviewed commit: "Ensure `expect as jestExpect` is exploit..." | Re-trigger Greptile

Comment thread docs/Framework.md Outdated
Comment thread docs/Framework.md Outdated
Comment thread docs/Framework.md Outdated
Comment thread playgrounds/mocha/tsconfig.json Outdated
dprevost-LMI and others added 4 commits June 28, 2026 18:26
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@dprevost-LMI dprevost-LMI changed the title docs: Review docs before Jasmine big release docs: Review docs before Jasmine better typing release Jun 29, 2026
@dprevost-LMI dprevost-LMI merged commit eecd89f into webdriverio:main Jun 29, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant