Skip to content

feat: adding check in normalizeDoc function to make sure readmeArr is of string type#14481

Merged
christian-bromann merged 3 commits intowebdriverio:mainfrom
Kauanldsbarbosa:main
May 15, 2025
Merged

feat: adding check in normalizeDoc function to make sure readmeArr is of string type#14481
christian-bromann merged 3 commits intowebdriverio:mainfrom
Kauanldsbarbosa:main

Conversation

@Kauanldsbarbosa
Copy link
Contributor

@Kauanldsbarbosa Kauanldsbarbosa commented May 14, 2025

Proposed changes

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

@Kauanldsbarbosa
Copy link
Contributor Author

Kauanldsbarbosa commented May 14, 2025

when I try to run the command pnpm watch:docs this error appears:

TypeError: Cannot read properties of undefined (reading 'startsWith') at <anonymous> (/home/kauan/projetos/webdriver/v1/webdriverio/scripts/docs-generation/3rdPartyDocs.ts:130:50) at Array.some (<anonymous>) at normalizeDoc (/home/kauan/projetos/webdriver/v1/webdriverio/scripts/docs-generation/3rdPartyDocs.ts:130:27) at generate3rdPartyDocs (/home/kauan/projetos/webdriver/v1/webdriverio/scripts/docs-generation/3rdPartyDocs.ts:87:25) at process.processTicksAndRejections (node:internal/process/task_queues:95:5) at <anonymous> (/home/kauan/projetos/webdriver/v1/webdriverio/scripts/docs-generation/generateDocs.ts:44:5)

That's why I made the change

@pkg-pr-new
Copy link

pkg-pr-new bot commented May 14, 2025 •
edited
Loading

Open in StackBlitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/browser-runner

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

@wdio/browserstack-service

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

@wdio/appium-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: b794179

christian-bromann
christian-bromann approved these changes May 15, 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.

LGTM 👍

@christian-bromann christian-bromann added the PR: Internal 🏠 PRs that contain changes internals label May 15, 2025
@christian-bromann christian-bromann merged commit 5c3868b into webdriverio:main May 15, 2025
6 checks passed
@wdio-bot
Copy link
Contributor

wdio-bot commented May 15, 2025

Hey Kauanldsbarbosa 👋

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 $15 💸 PR: Internal 🏠 PRs that contain changes internals

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Kauanldsbarbosa @wdio-bot @christian-bromann