Merge pull request #1 from mark0203/Cypress_Typescript_empty_framework

Adjust framework to use Typescript

CYPRESS.md

@@ -49,6 +49,28 @@ Cypress is a test automation tool that make testing fairly easy. Here is what yo
     * Convert all .js files to .ts files
 * Go over the best [practices page](https://docs.cypress.io/guides/references/best-practices)
 
+# Typescript
+Javascript is al fine, but what about using typescript? No problem, follow the steps below to install and configure Typescript.
+Just remember to use `pnpm` instead of `npm` for every installation part in the documentation.
+* [Cypress.io docs - Typescript](https://docs.cypress.io/guides/tooling/typescript-support)
+* `pnpm install --save-dev typescript`
+* Inside the `cypress` folder, add a file `tsconfig.json` with the following configuration
+```javascript
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress", "node"]
+  },
+  "include": ["**/*.ts"]
+}
+```
+* Rename the e2e spec from `*.cy.js` to `*.cy.ts`
+* Rename the support files to `*.ts` files
+* Rename `cypress.config.js` to `cypress.config.ts`
+* Run cypress to make sure it all works as expected
+  * `npm run cypress:open`
+
 # Examples
 
 ## E2E testing

cypress/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress", "node"]
+  },
+  "include": ["**/*.ts"]
+}

package.json

@@ -1,6 +1,7 @@
 {
   "devDependencies": {
-    "cypress": "^12.17.3"
+    "cypress": "^12.17.3",
+    "typescript": "^5.1.6"
   },
   "name": "ta_docs",
   "description": "This repo is used to document a bunch of test automation tools.\r The documentation is written in such a way anyone should be able to follow it.\r From installation to usage. Links to the original documentation. \r And even example code to test against (if needed).",