update TypeScript documentation #5604
Conversation
✅ Deploy Preview for benevolent-cat-040f48 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
target will need to be set to whatever release cypress-io/cypress#28709 makes it into |
There was a problem hiding this comment.
@AtofStryker Make sure to update the base branch to a 13.x branch before merging.
| { | ||
| "module": "commonjs", | ||
| "moduleResolution": "node", | ||
| "preserveValueImports": false // only applicable to TypeScript 4.5 and greater |
There was a problem hiding this comment.
@AtofStryker Someone left a note on a json example in our docs recently about how if you copy/paste it, it will be invalid due to the comments. I don't know if we want to update this so people don't copy/past the comment...........
There was a problem hiding this comment.
thats actually a good point. ill update it
There was a problem hiding this comment.
I just removed it since most are on typescript 4.5 and above and likely can infer if the setting is applied or not based on their version
… Cypress v13 and update changelog entry. Also add entry on values being overriden in the users tsconfig in order to make their typescript files executable inside the Cypress Node.js runtime
AtofStryker
force-pushed
the
update_typescript_documentation
branch
from
a88093a
to
b02b62c
Compare
| ### Processing your Cypress configuration and plugins | ||
|
|
||
| Cypress needs to be able to transpile your Cypress configuration and plugins written in TypeScript in order to make them executable within Cypress' Node.js runtime. | ||
| To do this, Cypress will attempt to read the user's TypeScript and project configuration to apply the correct TypeScript loader to Cypress' Node.js runtime. |
There was a problem hiding this comment.
Maybe we should point to where it reads this from... ie: /root/tsconfig.json etc
* chore: add changelog from 13.6.3 * update TypeScript documentation to display new minimum version set in Cypress v13 and update changelog entry. Also add entry on values being overriden in the users tsconfig in order to make their typescript files executable inside the Cypress Node.js runtime (#5604) * Update docs/guides/tooling/typescript-support.mdx Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> --------- Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>
updatesTypeScript documentation to display new minimum version set inCypress v13 and update changelog entry.
Also add entry on values being overridden in the users
tsconfig.jsonin order to make their typescript files executable inside the Cypress Node.js runtime