[Bug]: error TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.

Question

[Bug]: error TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.

broofa opened this issue 2 years ago · comments

Robert Kieffer commented 2 years ago

[For context, I originally opened this issue in the jest repo, but @SimenB said I should open a ticket here.]

Version

29.0.3

Steps to reproduce

Open up this SSCCE: https://replit.com/@broofa/JestImportMetaTest
Click "Run"

Expected behavior

Test should run w/out errors.

Actual behavior

Test fails with the error shown in the title.

Specifically, here's what I see:

Additional context

You can click "show files" in the repl.it window to see the tsconfig.json and package.json#jest setup.

As you'll see, I have the following configuration, so it's not clear what else I could/should do to work around this error:

{
  "compilerOptions": {
    "module": "es2020",
    "moduleResolution": "node",
    "target": "es2020",
    "esModuleInterop": true,
    "types": [
      "jest"
    ]
  }
}

Environment

~/JestImportMetaTest$ npx envinfo --preset jest.
Need to install the following packages:
  envinfo
Ok to proceed? (y) y

No "jest." preset found.
npm notice 
npm notice New major version of npm available! 7.20.3 -> 8.19.2
npm notice Changelog: https://github.com/npm/cli/releases/tag/v8.19.2
npm notice Run npm install -g npm@8.19.2 to update!
npm notice 
~/JestImportMetaTest$

Òscar Casajuana · Answer 1 · Wed Nov 16 2022 20:15:20 GMT+0800 (China Standard Time)

I'm experiencing this same issue, but having module defined as nodenext in my case.

Dev Yreham · Answer 2 · Mon Nov 21 2022 22:33:04 GMT+0800 (China Standard Time)

I have tried to follow every guides relating to the ESM issue and running with
node --experimental-vm-modules

the test should work.

We get this warning obviously "ExperimentalWarning: VM Modules is an experimental feature. This feature could change at any time"
It looks as if the compiler completly ignores the compilerOptions.module. It doesn't matter what module ESxx you put in.

While it makes the errors go away, it does not solve the use of import.meta.

Ahn · Answer 3 · Sun Dec 04 2022 19:16:06 GMT+0800 (China Standard Time)

This is related to configuration. Necessary configuration to run with ESM is not there. Please take a look at our example apps https://github.com/kulshekhar/ts-jest/tree/main/examples or documentation https://kulshekhar.github.io/ts-jest/docs/guides/esm-support

Robert Kieffer · Answer 4 · Sun Dec 04 2022 20:44:03 GMT+0800 (China Standard Time)

@ahnpnl I've just spent the last half-hour reading the docs you linked to and trying every combination of tsconfig and jest.config.js I could find therein. Including ...

Moving jest config out of package.json and into jest.config.js
Switching from "presets": "ts-jest" to "presets": "ts-jest/presets/default-esm"
Removing presets
Adding "useESM": true
Switching to "module": "CommonJS" in tsconfig
Adding/removing tsconfig: 'tsconfig.json', in tsconfig
Removing types, target, and moduleResolution in tsconfing

... and nothing helps. I keep getting the same error message.

I apologize for the trouble, but can you please tell me what configuration exactly I should be using here to get this to work?

Ahn · Answer 5 · Sun Dec 04 2022 21:11:03 GMT+0800 (China Standard Time)

I’ve linked the example repos. You can check them.

Robert Kieffer · Answer 6 · Sun Dec 04 2022 22:46:34 GMT+0800 (China Standard Time)

@ahnpnl I've checked the examples. Specifically: I've tried modifying the repl.it code, above, to use the configurations shown in both the ts-only and the type-module examples. I continue to get this error.

Is there a specific example i should be looking at? Within that example, is there specific tsconfig.* and jest.* files I should be using?

Unfortunately there's many examples and, within each example, many configuration files. I've done my best to investigate the various options shown but, based on what I'm seeing, I'm not convinced this is a configuration file issue.

Ahn · Answer 7 · Sun Dec 04 2022 22:55:07 GMT+0800 (China Standard Time)

If you wish to use type: module in package.json, type-module is the example project.
If you wish to NOT use type: module the other examples are the one.
Each example represents a different way to work with Jest, which you can check description here https://kulshekhar.github.io/ts-jest/docs/getting-started/presets.

In each example project, there is a jest-esm.config.js which already points to the tsconfig.json it is using. Besides, in package.json, the script to run test already contains the flag to use ESM with NodeJS.

Besides, if you are specifying transform, please remove preset from your Jest config.

The easiest way is you can clone one of the example apps and try out to compare with your repo. These example apps are included in CI so they are a good basic ones to start with.

Robert Kieffer · Answer 8 · Mon Dec 05 2022 02:51:21 GMT+0800 (China Standard Time)

Okay, I think I have this figured out. Debugging this was complicated by the fact there were two issues, either one of which would result in the same (not-at-all obvious) error message. Leaving breadcrumbs for anyone else who struggles with this...

The two missing pieces (for me) were the following:

jest has to be run with node's --experimental-vm-modules flag. I.e. Invoke jest as NODE_OPTIONS="--experimental-vm-modules" jest.
Configure jest with the ts-jest/presets/default-esm preset:

module.exports = {
  preset: 'ts-jest/presets/default-esm',
}

Sorry for the trouble @ahnpnl . I appreciate your patience. 🙌

Mike Lischke · Answer 9 · Mon Apr 03 2023 21:09:23 GMT+0800 (China Standard Time)

@broofa Your first suggestion does not work for me. With that setting I now get the error:

ReferenceError: exports is not defined

so as if jest would try with common js modules, instead of ESM.

Joe Cellucci · Answer 10 · Thu May 04 2023 02:35:49 GMT+0800 (China Standard Time)

@broofa Your first suggestion does not work for me. With that setting I now get the error:

ReferenceError: exports is not defined

so as if jest would try with common js modules, instead of ESM.

I am getting this same error, even with the following:

import { jsWithTsESM } from "ts-jest/presets";

/*
 * For a detailed explanation regarding each configuration property and type check, visit:
 * https://jestjs.io/docs/configuration
 */

export default {
  ...jsWithTsESM,
  transform: {
    "^.+\\.tsx?$": [
      "ts-jest",
      {
        tsconfig: "tsconfig.json",
        useESM: true,
      },
    ],
  },
};

and

    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest",

Tom Adler · Answer 11 · Thu Jun 15 2023 16:39:10 GMT+0800 (China Standard Time)

Configuring jest-ts-webcompat-resolver helped me in the same situation, I have no idea how

Amju · Answer 12 · Mon Sep 18 2023 01:22:01 GMT+0800 (China Standard Time)

Alternatively, you can use ts-jest-mock-import-meta npm package to fix this issue.

Install

npm install -D ts-jest-mock-import-meta

In jest.config.js

{
  // [...]
  transform: {
    '^.+\\.tsx?$': [
      'ts-jest',
      {
        diagnostics: {
          ignoreCodes: [1343]
        },
        astTransformers: {
          before: [
            {
              path: 'node_modules/ts-jest-mock-import-meta',  // or, alternatively, 'ts-jest-mock-import-meta' directly, without node_modules.
              options: { metaObjectReplacement: { url: 'https://www.url.com' } }
            }
          ]
        }
      }
    ]
  }
}

Muhammad Yousuf · Answer 13 · Mon Oct 09 2023 22:11:56 GMT+0800 (China Standard Time)

Alternatively, you can use ts-jest-mock-import-meta npm package to fix this issue.

Install

npm install -D ts-jest-mock-import-meta

In jest.config.js

{
  // [...]
  transform: {
    '^.+\\.tsx?$': [
      'ts-jest',
      {
        diagnostics: {
          ignoreCodes: [1343]
        },
        astTransformers: {
          before: [
            {
              path: 'node_modules/ts-jest-mock-import-meta',  // or, alternatively, 'ts-jest-mock-import-meta' directly, without node_modules.
              options: { metaObjectReplacement: { url: 'https://www.url.com' } }
            }
          ]
        }
      }
    ]
  }
}

this did solve the issue. 👌

␀ ₱ƦØ₽ℌ€₮ · Answer 14 · Sat Dec 16 2023 08:51:16 GMT+0800 (China Standard Time)

tried it in an esModule project and the package references above causes an error saying the __filename has already been defined.

There is an open issue on his site with no fix/answer:

ThomZz/ts-jest-mock-import-meta#5

I can't believe after all these years, using modules is still so hard and cumbersome/broken 👎