From 290d91e6b50942648176f1e54e5439abb8a1f4a0 Mon Sep 17 00:00:00 2001
From: Ziwei Wang <ziwei.wang@savoirfairelinux.com>
Date: Wed, 28 Aug 2024 11:34:37 -0400
Subject: [PATCH] Chore: Document the declaration file for cypress custom
commands
Change-Id: If9c508a56d3818c2c57aaef7d1acfd801bedb155
---
client/cypress/README.md | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/client/cypress/README.md b/client/cypress/README.md
index 7425b3ca..eee7f916 100644
--- a/client/cypress/README.md
+++ b/client/cypress/README.md
@@ -8,6 +8,7 @@
- [Prerequisites](#prerequisites)
- [Test Platforms](#test-platforms)
- [Test Environment Variables](#test-environment-variables)
+ - [Custom Commands](#custom-commands)
- [Test Flow](#test-flow)
- [Success Login](#success-login)
- [Success Logout](#success-logout)
@@ -39,6 +40,10 @@ Environment variables can be different across different machines. Machine specif
Before running any tests, make sure all the variables are set correctly in `cypress.env.json`. Refer to `cypress.env.example.json` for what variables are needed.
+## Custom Commands
+
+Cypress allows custom commands to be added via `support/command.ts`. However, an extra step is required for a TypeScript project like this one. The Cypress interface must be extended for TypeScript to correctly infer the types when adding a custom command. See `support/cypress.d.ts` for more details.
+
## Test Flow
---
--
GitLab