Repository navigation
docs: bring the adapter READMEs in line with the code and the website - #431
Merged
Merged
Conversation
Several README statements had drifted from the code they describe, and the website pages (webdriverio/webdriverio#16071) now state the corrected behaviour, so the two sides would disagree. Correct Nightwatch Cucumber nesting (Feature to Scenario), its per-session screencast and output path, the Selenium import-order claim, the Python README's claim that per-test slicing does not exist, the service's fluent-ffmpeg step and removed trace JSON, which formats show-trace opens, the port default, TestLens, the action allow-list and the elements peer range. Add the Mobile (Appium) sections, the Nightwatch requirements and the webSocketUrl advice the website documents. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Several README statements had drifted from the code they describe. The matching website pages are corrected in webdriverio/webdriverio#16071, so without this the README and webdriver.io would disagree. Every change was checked against the current code.
Corrected
@wdio/devtools-trace, not core.test-results/. Frames are taken over the WebDriver HTTP transport, notbrowser.takeScreenshot()../examplefolder; it now lists the top-levelexamples/nightwatch/demos.selenium-webdriver. Order doesn't matter: the plugin patches Selenium's prototypes as it loads, and every import finishes before test code runs.fluent-ffmpegalready installs with the service, so the separate install step is gone.wdio-trace-*.jsonoutput is no longer written.test-results/.portdefault is 3000, not random.show-traceopens a.ziponly.packages/shared/src/trace-actions.ts, with its real exclusions.pip install selenium-devtools-pycomes first.@wdio/elements. The peer range is^9 || ^10, and Nightwatch prefers CSS locators.Added, to match the website
@cucumber/cucumbertaken from your own project)webSocketUrl: trueeven withoutbidimaxBufferFramesCLAUDE.mdgets the same timer-flow correction as the root README.Type of change
Packages touched
shared(types and contracts)core(framework-agnostic capture/reporting)elements(published element/snapshot API —@wdio/elements)service(WebdriverIO adapter)nightwatch-devtools(Nightwatch adapter)selenium-devtools(Selenium adapter)selenium-devtools-py(Selenium Python adapter)backend(server)app(UI)script(page-injected runtime)trace(Trace mode)Notes for reviewers
pnpm build,pnpm test(2509 passed) andpnpm lintare green.src/, so it needs nochanges/fragment.DevTools.configure()apply the options the Selenium README already documents.main, so they are left alone to keep the diff to content.🤖 Generated with Claude Code