feat: TypeScript migration, add typings (#77)

Closes #43
component-driven · Nov 21, 2020 · 9249d2a · 9249d2a
1 parent 3fca563
commit 9249d2a
Show file tree

Hide file tree

Showing 6 changed files with 329 additions and 16 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,5 +1,5 @@
 {
-	"extends": "tamia",
+	"extends": "tamia/typescript",
 	"globals": {
 		"cy": false,
 		"Cypress": false,

diff --git a/README.md b/README.md
@@ -26,6 +26,22 @@ import 'cypress-axe'
 
 4. **Add a task to log the messages to the terminal** when Cypress executes the spec files. [Example - configuring log task](https://docs.cypress.io/api/commands/task.html#Usage).
 
+### TypeScript
+
+If you’re using TypeScript, add cypress-axe types to your Cypress’ `tsconfig.json` file:
+
+```json
+{
+  "compilerOptions": {
+    "baseUrl": "./",
+    "target": "es5",
+    "lib": ["esnext", "dom"],
+    "types": ["cypress", "cypress-axe"]
+  },
+  "include": ["."]
+}
+```
+
 ## Commands
 
 ### cy.injectAxe