ERR_REQUIRE_ESM when using Node.js ESM in tandem with TypeScript config (commitlint.config.ts)
See original GitHub issue// package.json
{
"type": "module"
}
// tsconfig.json
{
"compilerOptions": {
"module": "node16"
}
}
Expected Behavior
With the given setup above, executing npx commitlint --to HEAD
should not result in ERR_REQUIRE_ESM
error.
Current Behavior
Currently, the above setup is giving the following output:
./node_modules/ts-node/dist-raw/node-internal-errors.js:46
const err = new Error(getErrRequireEsmMessage(filename, parentPath, packageJsonPath))
^
Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: ./commitlint.config.ts
require() of ES modules is not supported.
require() of ./commitlint.config.ts from ./node_modules/cosmiconfig-typescript-loader/dist/loader.js is an ES module file as it is a .ts file whose nearest parent package.json contains "type": "module" which defines all .ts files in that package scope as ES modules.
Instead change the requiring code to use import(), or remove "type": "module" from ./package.json.
at createErrRequireEsm (./node_modules/ts-node/dist-raw/node-internal-errors.js:46:15)
at assertScriptCanLoadAsCJSImpl (./node_modules/ts-node/dist-raw/node-internal-modules-cjs-loader.js:584:11)
at Object.require.extensions.<computed> [as .ts] (./node_modules/ts-node/src/index.ts:1589:5)
at Module.load (node:internal/modules/cjs/loader:988:32)
at Function.Module._load (node:internal/modules/cjs/loader:834:12)
at Module.require (node:internal/modules/cjs/loader:1012:19)
at require (node:internal/modules/cjs/helpers:102:18)
at loader (./node_modules/cosmiconfig-typescript-loader/dist/loader.js:12:28)
at Explorer.loadFileContent (./node_modules/cosmiconfig/src/Explorer.ts:81:32)
at Explorer.createCosmiconfigResult (./node_modules/cosmiconfig/src/Explorer.ts:89:36) {
name: 'TypeScriptCompileError'
}
Affected packages
- cli
- core
- prompt
- config-angular
Possible Solution
- Support
commitlint.config.cts
, or - Use
import()
to load config
Steps to Reproduce (for bugs)
- First step: Minimal setup of
commitlint
according to the official documentation withpackage.json
andtsconfig.json
supplied above. - Second step: Run
npx commitlint --to HEAD
.
commitlint.config.ts
import type { UserConfig } from "@commitlint/types";
const config: UserConfig = {
extends: ["@commitlint/config-conventional"],
};
export default config;
Context
Without touching tsconfig.json
, if I remove "type": "module"
from package.json
, npx commitlint --to HEAD
can be executed successfully.
But this is not plausible since I have migrated the whole repository to Node.js ESM since the release of TypeScript 4.7 officially supporting it.
Raising this issue as people with similar setup will encounter this as well.
Currently resorted to using commitlint.config.cjs
, but still prefer to have commitlint.config.ts
in the long run.
Your Environment
Executable | Version |
---|---|
commitlint --version |
17.0.2 |
git --version |
2.36.1 |
node --version |
18.4.0 |
Issue Analytics
- State:
- Created a year ago
- Reactions:8
- Comments:5
Top Results From Across the Web
TypeScript and native ESM on Node.js - 2ality
In this blog post, I'll explain everything you need to know in order to use and produce native ECMAScript modules on Node.js.
Read more >Error [ERR_REQUIRE_ESM] - Husky, lint-staged, eslint
The problem is, the project is in it's first steps, quickly redoing the project in another machine on the same node and yarn,...
Read more >ts-node error [err_require_esm]: require() of es module
ts Error: Jest: Failed to parse the TypeScript config file C:\Projects\appAngularfrontend\kendoUpdate\jes t.config.ts Error [ERR_REQUIRE_ESM]: require() of ES ...
Read more >Using ES Modules (ESM) in Node.js: A Practical Guide (Part 3)
Let's start exploring the package, tool by tool. We'll start with the most important of them, ESLint. ESlint configuration for Node.js ESM #....
Read more >Error ERR REQUIRE ESM | Must use import to load ES Module
How to use ES Modules in Node. · Top 5 Excel Functions for Finance People (with end-to-end example) · Require vs Import Javascript...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
We also have the same issue after migrating to ESM, can confirm that renaming
commitlint.config.js
tocommitlint.config.cjs
works as a temporary fixRenaming
commitlint.config.ts
tocommitlint.config.cts
doesn’t work in my case:So currently commitlint doesn’t support
.(ts|cts|mts|js|mjs)
configs…