Skip to content

fix: fix in docs formatter to accept new types#14335

Merged
christian-bromann merged 1 commit intowebdriverio:mainfrom
Rondleysg:main
Mar 27, 2025
Merged

fix: fix in docs formatter to accept new types#14335
christian-bromann merged 1 commit intowebdriverio:mainfrom
Rondleysg:main

Conversation

@Rondleysg
Copy link
Member

@Rondleysg Rondleysg commented Mar 27, 2025

Proposed changes

This pull request fixes the docs formatter to accept and format new param types (e.g. * @param {{user: string, pass: string}=} options.auth or * @param {'none' | 'interactive' | 'networkIdle' | 'complete'} options.wait). Currently, trying to generate the docs for browser/url.ts is giving the error TypeError: type.replace is not a function, so this PR fixes that.

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to the project's docs)
  • Specification changes (updates to WebDriver command specifications)
  • Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Reviewers: @webdriverio/project-committers

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 27, 2025

Open in Stackblitz

eslint-plugin-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@14335

@wdio/allure-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@14335

@wdio/browser-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@14335

@wdio/browserstack-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@14335

@wdio/appium-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@14335

@wdio/cli

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@14335

@wdio/concise-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@14335

@wdio/config

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@14335

@wdio/cucumber-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@14335

@wdio/dot-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@14335

@wdio/firefox-profile-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@14335

@wdio/globals

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@14335

@wdio/jasmine-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@14335

@wdio/json-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@14335

@wdio/junit-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@14335

@wdio/lighthouse-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@14335

@wdio/local-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@14335

@wdio/logger

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@14335

@wdio/mocha-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@14335

@wdio/protocols

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@14335

@wdio/repl

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@14335

@wdio/reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@14335

@wdio/runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@14335

@wdio/sauce-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@14335

@wdio/shared-store-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@14335

@wdio/smoke-test-cjs-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@14335

@wdio/smoke-test-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@14335

@wdio/smoke-test-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@14335

@wdio/spec-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@14335

@wdio/static-server-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@14335

@wdio/sumologic-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@14335

@wdio/testingbot-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@14335

@wdio/types

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@14335

@wdio/utils

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@14335

@wdio/webdriver-mock-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@14335

webdriver

npm i https://pkg.pr.new/webdriverio/webdriverio/webdriver@14335

webdriverio

npm i https://pkg.pr.new/webdriverio/webdriverio@14335

commit: cb8bb70

christian-bromann
christian-bromann approved these changes Mar 27, 2025
View reviewed changes
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🫶 Thanks a lot

@christian-bromann christian-bromann added the PR: Docs 📝 PRs that contain changes to the documentation label Mar 27, 2025
@christian-bromann christian-bromann merged commit eaa075b into webdriverio:main Mar 27, 2025
42 of 43 checks passed
@wdio-bot
Copy link
Contributor

wdio-bot commented Mar 27, 2025

Hey Rondleysg 👋

Thank you for your contribution to WebdriverIO! Your pull request has been marked as an "Expensable" contribution.

We've sent you an email with further instructions on how to claim your expenses from our development fund.
Please make sure to check your spam folder as well. If you have any questions, feel free to reach out to us at expense@webdriver.io or in the contributing channel on Discord.

We are looking forward to more contributions from you in the future 🙌

Have a nice day,
The WebdriverIO Team 🤖

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christian-bromann christian-bromann christian-bromann approved these changes

Assignees

No one assigned

Labels

Expensable $35 💸 PR: Docs 📝 PRs that contain changes to the documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Rondleysg @wdio-bot @christian-bromann