From fb2daf49f3a5a819a479ef825409ef94458ae67f Mon Sep 17 00:00:00 2001 From: Ahn <27772165+ahnpnl@users.noreply.github.com> Date: Mon, 7 Nov 2022 18:23:36 +0100 Subject: [PATCH] docs: add explanation for `supportsStaticESM` transform option (#12028) --- docs/CodeTransformation.md | 8 ++++++++ website/versioned_docs/version-27.x/CodeTransformation.md | 8 ++++++++ website/versioned_docs/version-28.x/CodeTransformation.md | 8 ++++++++ website/versioned_docs/version-29.0/CodeTransformation.md | 8 ++++++++ website/versioned_docs/version-29.1/CodeTransformation.md | 8 ++++++++ website/versioned_docs/version-29.2/CodeTransformation.md | 8 ++++++++ 6 files changed, 48 insertions(+) diff --git a/docs/CodeTransformation.md b/docs/CodeTransformation.md index 2d16208eb10f..8b712c7e51c9 100644 --- a/docs/CodeTransformation.md +++ b/docs/CodeTransformation.md @@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows: interface TransformOptions { supportsDynamicImport: boolean; supportsExportNamespaceFrom: boolean; + /** + * The value is: + * - `false` if Jest runs without Node ESM flag `--experimental-vm-modules` + * - `true` if the file extension is defined in [extensionsToTreatAsEsm](Configuration.md#extensionstotreatasesm-arraystring) + * and Jest runs with Node ESM flag `--experimental-vm-modules` + * + * See more at https://jestjs.io/docs/next/ecmascript-modules + */ supportsStaticESM: boolean; supportsTopLevelAwait: boolean; instrument: boolean; diff --git a/website/versioned_docs/version-27.x/CodeTransformation.md b/website/versioned_docs/version-27.x/CodeTransformation.md index 46476a08da6c..bf97210d3284 100644 --- a/website/versioned_docs/version-27.x/CodeTransformation.md +++ b/website/versioned_docs/version-27.x/CodeTransformation.md @@ -110,6 +110,14 @@ interface TransformOptions { // names are copied from babel: https://babeljs.io/docs/en/options#caller supportsDynamicImport: boolean; supportsExportNamespaceFrom: boolean; + /** + * The value is: + * - `false` if Jest runs without Node ESM flag `--experimental-vm-modules` + * - `true` if the file extension is defined in [extensionsToTreatAsEsm](Configuration.md#extensionstotreatasesm-arraystring) + * and Jest runs with Node ESM flag `--experimental-vm-modules` + * + * See more at https://jestjs.io/docs/27.x/ecmascript-modules + */ supportsStaticESM: boolean; supportsTopLevelAwait: boolean; /** the options passed through Jest's config by the user */ diff --git a/website/versioned_docs/version-28.x/CodeTransformation.md b/website/versioned_docs/version-28.x/CodeTransformation.md index 2d16208eb10f..9bf80b90352c 100644 --- a/website/versioned_docs/version-28.x/CodeTransformation.md +++ b/website/versioned_docs/version-28.x/CodeTransformation.md @@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows: interface TransformOptions { supportsDynamicImport: boolean; supportsExportNamespaceFrom: boolean; + /** + * The value is: + * - `false` if Jest runs without Node ESM flag `--experimental-vm-modules` + * - `true` if the file extension is defined in [extensionsToTreatAsEsm](Configuration.md#extensionstotreatasesm-arraystring) + * and Jest runs with Node ESM flag `--experimental-vm-modules` + * + * See more at https://jestjs.io/docs/28x/ecmascript-modules + */ supportsStaticESM: boolean; supportsTopLevelAwait: boolean; instrument: boolean; diff --git a/website/versioned_docs/version-29.0/CodeTransformation.md b/website/versioned_docs/version-29.0/CodeTransformation.md index 2d16208eb10f..39a47b5d653f 100644 --- a/website/versioned_docs/version-29.0/CodeTransformation.md +++ b/website/versioned_docs/version-29.0/CodeTransformation.md @@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows: interface TransformOptions { supportsDynamicImport: boolean; supportsExportNamespaceFrom: boolean; + /** + * The value is: + * - `false` if Jest runs without Node ESM flag `--experimental-vm-modules` + * - `true` if the file extension is defined in [extensionsToTreatAsEsm](Configuration.md#extensionstotreatasesm-arraystring) + * and Jest runs with Node ESM flag `--experimental-vm-modules` + * + * See more at https://jestjs.io/docs/29.0/ecmascript-modules + */ supportsStaticESM: boolean; supportsTopLevelAwait: boolean; instrument: boolean; diff --git a/website/versioned_docs/version-29.1/CodeTransformation.md b/website/versioned_docs/version-29.1/CodeTransformation.md index 2d16208eb10f..bcc5a42f3ad5 100644 --- a/website/versioned_docs/version-29.1/CodeTransformation.md +++ b/website/versioned_docs/version-29.1/CodeTransformation.md @@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows: interface TransformOptions { supportsDynamicImport: boolean; supportsExportNamespaceFrom: boolean; + /** + * The value is: + * - `false` if Jest runs without Node ESM flag `--experimental-vm-modules` + * - `true` if the file extension is defined in [extensionsToTreatAsEsm](Configuration.md#extensionstotreatasesm-arraystring) + * and Jest runs with Node ESM flag `--experimental-vm-modules` + * + * See more at https://jestjs.io/docs/29.1/ecmascript-modules + */ supportsStaticESM: boolean; supportsTopLevelAwait: boolean; instrument: boolean; diff --git a/website/versioned_docs/version-29.2/CodeTransformation.md b/website/versioned_docs/version-29.2/CodeTransformation.md index 2d16208eb10f..146f20933387 100644 --- a/website/versioned_docs/version-29.2/CodeTransformation.md +++ b/website/versioned_docs/version-29.2/CodeTransformation.md @@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows: interface TransformOptions { supportsDynamicImport: boolean; supportsExportNamespaceFrom: boolean; + /** + * The value is: + * - `false` if Jest runs without Node ESM flag `--experimental-vm-modules` + * - `true` if the file extension is defined in [extensionsToTreatAsEsm](Configuration.md#extensionstotreatasesm-arraystring) + * and Jest runs with Node ESM flag `--experimental-vm-modules` + * + * See more at https://jestjs.io/docs/ecmascript-modules + */ supportsStaticESM: boolean; supportsTopLevelAwait: boolean; instrument: boolean;