Skip to content

Add typescript installations instructions to README.md #43

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Add typescript installations instructions to README.md #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,27 @@ Update `Cypress/support/index.js` file to include the cypress-axe commands by ad
import 'cypress-axe'
```

### Add types (typescript only)

```sh
npm i -D @types/axe-core @types/cypress-axe
```
Update `Cypress/tsconfig.json` file to include the cypress-axe and axe-core types:

```json
{
"compilerOptions": {
"types": ["cypress", "cypress-axe", "axe-core"]
Copy link

@quantizor quantizor Sep 1, 2020

Choose a reason for hiding this comment

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

I didn't need to do this step just FYI, installing the types was enough

}
}
```


### Add a task to log the messages to the terminal when the cypress executes the spec files

[Example - configuring log task](https://docs.cypress.io/api/commands/task.html#Usage)


## Commands

### cy.injectAxe
Expand Down