From 0db25cecb2ad578932947cec503480e76aa0f05e Mon Sep 17 00:00:00 2001 From: javierbrea Date: Wed, 10 Aug 2022 09:14:01 +0200 Subject: [PATCH] docs: Add note about allowSyntheticDefaultExports --- packages/cypress-commands/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/cypress-commands/README.md b/packages/cypress-commands/README.md index bbe53a239..ab3c5154e 100644 --- a/packages/cypress-commands/README.md +++ b/packages/cypress-commands/README.md @@ -192,12 +192,13 @@ describe("users page", () => { For those writing [TypesScript tests in Cypress][cypress-typescript], this package includes TypeScript declarations. -Add "@mocks-server/cypress-commands" to the `types` property in the `tsconfig.json` file: +Add "@mocks-server/cypress-commands" to the `types` property in the `tsconfig.json` file. You may also need to set the TS `allowSyntheticDefaultImports` option to true: ```json { "compilerOptions": { - "types": ["cypress", "@mocks-server/cypress-commands"] + "types": ["cypress", "@mocks-server/cypress-commands"], + "allowSyntheticDefaultImports": true } } ```