Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/grumpy-plants-think.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/testing': patch
---

Add experimental console warning on Cypress setup function
2 changes: 2 additions & 0 deletions packages/testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ test("sign up", async ({ page }) => {

### Cypress

⚠️ **Please note:** Support for Cypress is still experimental. Be aware that there are limitations and potential issues at this stage. Please open an issue with a minimal reproduction so that these issues can be fixed. Thanks!

Firstly, add your Clerk keys (`CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY`) to your environment variables file (e.g. `.env.local` or `.env.`).
You can find these keys in your Clerk Dashboard.

Expand Down
5 changes: 5 additions & 0 deletions packages/testing/src/cypress/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ type ClerkSetupParams = {
* @throws An error if the Cypress config object is not provided.
*/
export const clerkSetup = async ({ config, options }: ClerkSetupParams) => {
console.log(
'\x1b[33m%s\x1b[0m',
'@clerk/testing: Support for Cypress is experimental and subject to change in the future.',
);

if (!config) {
throw new Error('The Cypress config object is required.');
}
Expand Down