docs: add explanation for supportsStaticESM transform option (#12028)

jestjs · Nov 7, 2022 · fb2daf4 · fb2daf4
1 parent 73550fd
commit fb2daf4
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 0 deletions.
diff --git 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<TransformerConfig = unknown> {
   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
@@ -110,6 +110,14 @@ interface TransformOptions<OptionType> {
   // 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
@@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows:
 interface TransformOptions<TransformerConfig = unknown> {
   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
@@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows:
 interface TransformOptions<TransformerConfig = unknown> {
   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
@@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows:
 interface TransformOptions<TransformerConfig = unknown> {
   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
@@ -36,6 +36,14 @@ You can write your own transformer. The API of a transformer is as follows:
 interface TransformOptions<TransformerConfig = unknown> {
   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;