Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add typescript requirement in intro
  • Loading branch information
annaet authored Feb 26, 2021
1 parent 0ee4c24 commit ce36fb7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Use custom tags to slice up Cypress test runs.

See [cypress-tags-example](https://github.com/annaet/cypress-tags-example) for a working example.

This plugin uses TypeScript to parse the tests, so you will need `typescript` installed in your project.

## Install

`npm install cypress-tags`
Expand Down Expand Up @@ -118,4 +120,4 @@ This means that in an example test as shown below:
it([generateTagName()], 'I will also become a wip test', () => {});
```

The `generateTagName()` function will not resolve before the tests are filtered out. The typescript code itself will be passed into the Typescript Compiler API and the generated AST will be different to what is expected by the plugin.
The `generateTagName()` function will not resolve before the tests are filtered out. The typescript code itself will be passed into the Typescript Compiler API and the generated AST will be different to what is expected by the plugin.

0 comments on commit ce36fb7

Please sign in to comment.