Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Docs: Add Potential issues with Jest testing React docs section #17032

Merged
merged 15 commits into from
Sep 6, 2024

Conversation

Mati365
Copy link
Member

@Mati365 Mati365 commented Sep 3, 2024

Suggested merge commit message (convention)

Docs: Add Potential issues with Jest testing section to React integration docs.


Additional information

Related to ckeditor/ckeditor5-react#225

I added this section to address the increasing number of reports regarding issues with Jest testing in React applications. This explanation clarifies the limitations of Jest when used with CKEditor 5 and provides a solution for more accurate testing by using jest-puppeteer or a mock snippet.

@Mati365 Mati365 added the type:docs This issue reports a task related to documentation (e.g. an idea for a guide). label Sep 3, 2024
@Mati365 Mati365 requested review from Witoso and godai78 September 3, 2024 11:55
@godai78
Copy link
Contributor

godai78 commented Sep 3, 2024

Is master the proper target?

@Mati365 Mati365 changed the base branch from master to stable September 3, 2024 11:57
@Mati365 Mati365 force-pushed the ck/jsdom-react-jest-docs-update branch from 9a5e14d to 2ac8dcc Compare September 3, 2024 11:58
@Mati365
Copy link
Member Author

Mati365 commented Sep 3, 2024

@godai78 rebased

godai78
godai78 previously approved these changes Sep 3, 2024
godai78
godai78 previously approved these changes Sep 4, 2024
godai78
godai78 previously approved these changes Sep 5, 2024
Copy link
Contributor

@gorzelinski gorzelinski left a comment

Choose a reason for hiding this comment

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

I added some suggestions.

docs/getting-started/integrations/angular.md Show resolved Hide resolved
docs/getting-started/integrations/react.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/angular.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/angular.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/angular.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/react.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/react.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/vuejs-v3.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/vuejs-v3.md Outdated Show resolved Hide resolved
docs/getting-started/integrations/vuejs-v3.md Outdated Show resolved Hide resolved
@Mati365 Mati365 requested a review from gorzelinski September 5, 2024 13:30
@Witoso
Copy link
Member

Witoso commented Sep 5, 2024

As we removed jest-pupeeter let's maybe say what, we think, is right: cypress, playwright, vitest in browser mode just o give people refenrece if they don't graps what's browser testing?

@Mati365
Copy link
Member Author

Mati365 commented Sep 6, 2024

@Witoso Good idea, I'll adjust a bit docs.

@Mati365
Copy link
Member Author

Mati365 commented Sep 6, 2024

@Witoso done

@Mati365 Mati365 requested review from Witoso and godai78 September 6, 2024 06:13
@Mati365 Mati365 merged commit 55a8ee9 into stable Sep 6, 2024
8 checks passed
@Mati365 Mati365 deleted the ck/jsdom-react-jest-docs-update branch September 6, 2024 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants