Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

fix: Puppeteer helper doc broken link #4369

Merged
merged 1 commit into from
Jun 3, 2024
Merged

fix: Puppeteer helper doc broken link #4369

merged 1 commit into from
Jun 3, 2024

Conversation

yoannfleurydev
Copy link
Contributor

@yoannfleurydev yoannfleurydev commented May 30, 2024 •
edited
Loading

Motivation/Description of the PR

  • Description of this PR, which problem it solves

Broken link in puppeteer helper documentation

Applicable helpers:

  • Playwright
  • Puppeteer
  • WebDriver
  • REST
  • FileHelper
  • Appium
  • TestCafe

Applicable plugins:

  • allure
  • autoDelay
  • autoLogin
  • customLocator
  • pauseOnFail
  • coverage
  • retryFailedStep
  • screenshotOnFail
  • selenoid
  • stepByStepReport
  • stepTimeout
  • wdio
  • subtitles

Type of change

  • 🔥 Breaking changes
  • 🚀 New functionality
  • 🐛 Bug fix
  • 🧹 Chore
  • 📋 Documentation changes/updates
  • ♨️ Hot fix
  • 🔨 Markdown files fix - not related to source code
  • 💅 Polish code

Checklist:

  • Tests have been added
  • Documentation has been added (Run npm run docs)
  • Lint checking (Run npm run lint)
  • Local tests are passed (Run npm test)

kobenguyent
kobenguyent requested changes May 31, 2024
View reviewed changes
Copy link
Collaborator

@kobenguyent kobenguyent left a comment

Choose a reason for hiding this comment

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

As the .md files are taken care by npm run docs

so please update here
https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/helper/Puppeteer.js#L2475
https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/helper/Puppeteer.js#L2480

then run npm run docs to update the documentations.

@yoannfleurydev
Copy link
Contributor Author

yoannfleurydev commented Jun 2, 2024 •
edited
Loading

@kobenguyent there is an issue while running npm run docs.

image

I installed dependencies (using --force) with Node.js 18 and Node.js 20 because it was not installing dependencies (#4371)

@yoannfleurydev yoannfleurydev mentioned this pull request Jun 2, 2024
Closed
@kobenguyent
Copy link
Collaborator

Could you try this npm run def && npm run docs

@yoannfleurydev
Copy link
Contributor Author

npm run def is giving me an error.

[#35 NPX] › ℹ  npx documentation build lib/plugin/*.js -o docs/plugins.md -f md --shallow --markdown-toc=false --sort-order=alpha
Building @codecepjs/detox helper docs
[#36 REPLACEINFILE] › ℹ  node_modules/@codeceptjs/detox-helper/Detox.js
[#36 REPLACEINFILE] › ✖  Failed with "ENOENT: no such file or directory, open 'node_modules/@codeceptjs/detox-helper/Detox.js'"  in 0 ms
[#36 REPLACEINFILE] › ⚠  warning   Execution stopped

And then running npm run docs is kind of giving me the same one.

> codeceptjs@3.6.2 docs
> ./runok.js docs

Writing documentation for AI
[#1 COPY] › ℹ  lib/helper/AI.js => docs/build/AI.js
[#1 COPY] › ✔  Finished  in 1 ms
[#2 REPLACEINFILE] › ℹ  docs/build/AI.js
[#2 REPLACEINFILE] › ✔  Finished  in 0 ms
[#3 NPX] › ℹ  npx documentation build docs/build/AI.js -o docs/helpers/AI.md -f md --shallow --markdown-toc=false --sort-order=alpha
[#4 NPX] › ℹ  npx documentation build lib/plugin/*.js -o docs/plugins.md -f md --shallow --markdown-toc=false --sort-order=alpha
Building @codecepjs/detox helper docs
[#5 REPLACEINFILE] › ℹ  node_modules/@codeceptjs/detox-helper/Detox.js
[#5 REPLACEINFILE] › ✖  Failed with "ENOENT: no such file or directory, open 'node_modules/@codeceptjs/detox-helper/Detox.js'"  in 0 ms
[#5 REPLACEINFILE] › ⚠  warning   Execution stopped

@kobenguyent
Copy link
Collaborator

npm run def is giving me an error.

[#35 NPX] › ℹ  npx documentation build lib/plugin/*.js -o docs/plugins.md -f md --shallow --markdown-toc=false --sort-order=alpha
Building @codecepjs/detox helper docs
[#36 REPLACEINFILE] › ℹ  node_modules/@codeceptjs/detox-helper/Detox.js
[#36 REPLACEINFILE] › ✖  Failed with "ENOENT: no such file or directory, open 'node_modules/@codeceptjs/detox-helper/Detox.js'"  in 0 ms
[#36 REPLACEINFILE] › ⚠  warning   Execution stopped

And then running npm run docs is kind of giving me the same one.

> codeceptjs@3.6.2 docs
> ./runok.js docs

Writing documentation for AI
[#1 COPY] › ℹ  lib/helper/AI.js => docs/build/AI.js
[#1 COPY] › ✔  Finished  in 1 ms
[#2 REPLACEINFILE] › ℹ  docs/build/AI.js
[#2 REPLACEINFILE] › ✔  Finished  in 0 ms
[#3 NPX] › ℹ  npx documentation build docs/build/AI.js -o docs/helpers/AI.md -f md --shallow --markdown-toc=false --sort-order=alpha
[#4 NPX] › ℹ  npx documentation build lib/plugin/*.js -o docs/plugins.md -f md --shallow --markdown-toc=false --sort-order=alpha
Building @codecepjs/detox helper docs
[#5 REPLACEINFILE] › ℹ  node_modules/@codeceptjs/detox-helper/Detox.js
[#5 REPLACEINFILE] › ✖  Failed with "ENOENT: no such file or directory, open 'node_modules/@codeceptjs/detox-helper/Detox.js'"  in 0 ms
[#5 REPLACEINFILE] › ⚠  warning   Execution stopped

well, I think you haven't run npm i -f

@yoannfleurydev
fix: Puppeteer helper doc typo

Verified

This commit was signed with the committer’s verified signature.
a-r-r-o-w Aryan
GPG key ID: E4BC832FD777D7A5
Verified
Learn about vigilant mode
303b60d
@yoannfleurydev
Copy link
Contributor Author

Thanks a lot, I removed my node_modules and did again install force, and it worked.

The PR is updated with your feedbacks. Thanks a lot for your patience and answering my dumb questions 😄

@kobenguyent
Copy link
Collaborator

No worries @yoannfleurydev 😀 I bumped into the same thing when I first touched the codebase.

@kobenguyent kobenguyent merged commit e36d869 into codeceptjs:3.x Jun 3, 2024
13 checks passed
@yoannfleurydev yoannfleurydev deleted the patch-1 branch June 3, 2024 14:38
kobenguyent added a commit that referenced this pull request Jun 7, 2024
@Horsty80 @a-stankevich
@andonary @actions-user @kobenguyent @yoannfleurydev @dependabot
fix: handle throw error inside retryTo promise (#4377)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
cbe818a 
* fix(webApi): error message of dontSeeCookie (#4357)

* Fixed error message for dontSeeCookie()

* fix(cli): gherkin command init with TypeScript (#4366)

* DOC: Update contributor faces

* fix(doc): Expect helper is not described correctly (#4370)

* fix: Puppeteer helper doc typo (#4369)

* chore(deps): bump devtools from 8.36.1 to 8.38.0 (#4374)

* chore(deps-dev): bump playwright from 1.44.0 to 1.44.1 (#4376)

Bumps [playwright](https://github.com/microsoft/playwright) from 1.44.0 to 1.44.1.
- [Release notes](https://github.com/microsoft/playwright/releases)
- [Commits](microsoft/playwright@v1.44.0...v1.44.1)

---
updated-dependencies:
- dependency-name: playwright
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump axios from 1.6.7 to 1.7.2 (#4372)

* chore(deps-dev): bump typedoc-plugin-markdown from 3.17.1 to 4.0.3 (#4373)

* fix: handle throw error inside retryTo promise

* fix: test due to update on retryTo plugin

* fix: add a test case succeed after 2 retry

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Arthur Stankevich <a-stankevich@users.noreply.github.com>
Co-authored-by: Ando NARY <36852616+andonary@users.noreply.github.com>
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: KobeN <7845001+kobenguyent@users.noreply.github.com>
Co-authored-by: Yoann Fleury <yoann.fleury@yahoo.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@kobenguyent kobenguyent mentioned this pull request Jun 10, 2024
Merged
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@kobenguyent kobenguyent

@Arhell Arhell

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@yoannfleurydev @kobenguyent @Arhell