ERR_REQUIRE_ESM when using Node.js ESM in tandem with TypeScript config (commitlint.config.ts) #3251

shian15810 · 2022-06-23T23:37:54Z

// 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 with package.json and tsconfig.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

The text was updated successfully, but these errors were encountered:

escapedcat · 2022-06-24T01:07:44Z

Thanks for raising this

erayaydin · 2022-07-03T03:36:43Z

Same problem and I'm agree with @shian15810 's described context.

Executable	Version
commitlint	17.0.3
git	2.36.1
node	18.3.0

I also prefer ts extension for configure commitlint.

jjbell150 · 2022-08-19T02:22:26Z

We also have the same issue after migrating to ESM, can confirm that renaming commitlint.config.js to commitlint.config.cjs works as a temporary fix

- conventional-changelog/commitlint#3251 오류로 인해 `.cjs` 확장과 jsdoc 타입 체크로 대신함 - 커밋 메시지에 한글을 사용하므로, 영어 케이스 규칙은 사용하지 않음

ZerdoX-x · 2022-12-26T05:19:51Z

Renaming commitlint.config.ts to commitlint.config.cts doesn't work in my case:

/Users/user/path/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/ExplorerBase.ts:109
      throw new Error(
            ^
Error: No loader specified for extension ".cts"
    at Explorer.getLoaderEntryForFile (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/ExplorerBase.ts:109:13)
    at Explorer.loadFileContent (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:80:25)
    at Explorer.createCosmiconfigResult (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:89:36)
    at runLoad (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:104:33)
    at async cacheWrapper (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/cacheWrapper.ts:13:18)
    at async loadConfig (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/@commitlint+load@17.3.0/node_modules/@commitlint/load/src/utils/load-config.ts:42:16)
    at async load (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/@commitlint+load@17.3.0/node_modules/@commitlint/load/src/load.ts:25:17)
    at async main (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/@commitlint+cli@17.3.0/node_modules/@commitlint/cli/src/cli.ts:214:17)
husky - commit-msg hook exited with code 1 (error)

So currently commitlint doesn't support .(ts|cts|mts|js|mjs) configs...

escapedcat · 2022-12-26T11:48:30Z

#3461 might help. It was just merged but not yet released.

SalahAdDin · 2022-12-26T12:32:25Z

"ts-node": {
"esm": true
},

It didn't work for me.

This is my case, it is not a direct dependency, it is a commitlint dependency, and testing the package from CLI I'm getting the bug:

 echo "[PAP-2013] feat(lang): :arrow_up: add Polish language" | pnpm commit    

> react-ts-vite-template@0.1.0 commit /home/luisalaguna/Projects/react-ts-vite-template
> commitlint

/home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/ts-node@10.9.1_xplfzyzpegygk3axf4z63vz544/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: /home/luisalaguna/Projects/react-ts-vite-template/commitlint.config.ts
require() of ES modules is not supported.
require() of /home/luisalaguna/Projects/react-ts-vite-template/commitlint.config.ts from /home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/cosmiconfig-typescript-loader@4.3.0_or2qrscwofpw4jwfbychkdzroy/node_modules/cosmiconfig-typescript-loader/dist/cjs/index.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 /home/luisalaguna/Projects/react-ts-vite-template/package.json.

    at createErrRequireEsm (/home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/ts-node@10.9.1_xplfzyzpegygk3axf4z63vz544/node_modules/ts-node/dist-raw/node-internal-errors.js:46:15)
    at assertScriptCanLoadAsCJSImpl (/home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/ts-node@10.9.1_xplfzyzpegygk3axf4z63vz544/node_modules/ts-node/dist-raw/node-internal-modules-cjs-loader.js:584:11)
    at Object.require.extensions.<computed> [as .ts] (/home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/ts-node@10.9.1_xplfzyzpegygk3axf4z63vz544/node_modules/ts-node/src/index.ts:1610:5)
    at Module.load (node:internal/modules/cjs/loader:1037:32)
    at Function.Module._load (node:internal/modules/cjs/loader:878:12)
    at Module.require (node:internal/modules/cjs/loader:1061:19)
    at require (node:internal/modules/cjs/helpers:103:18)
    at loader (/home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/cosmiconfig-typescript-loader@4.3.0_or2qrscwofpw4jwfbychkdzroy/node_modules/cosmiconfig-typescript-loader/dist/cjs/index.js:59:22)
    at Explorer.loadFileContent (/home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:81:32)
    at Explorer.createCosmiconfigResult (/home/luisalaguna/Projects/react-ts-vite-template/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:89:36) {
  name: 'TypeScriptCompileError'
}
 ELIFECYCLE  Command failed with exit code 1.

Renaming commitlint.config.ts to commitlint.config.cts doesn't work in my case:

/Users/user/path/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/ExplorerBase.ts:109
      throw new Error(
            ^
Error: No loader specified for extension ".cts"
    at Explorer.getLoaderEntryForFile (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/ExplorerBase.ts:109:13)
    at Explorer.loadFileContent (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:80:25)
    at Explorer.createCosmiconfigResult (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:89:36)
    at runLoad (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/Explorer.ts:104:33)
    at async cacheWrapper (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/cosmiconfig@7.1.0/node_modules/cosmiconfig/src/cacheWrapper.ts:13:18)
    at async loadConfig (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/@commitlint+load@17.3.0/node_modules/@commitlint/load/src/utils/load-config.ts:42:16)
    at async load (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/@commitlint+load@17.3.0/node_modules/@commitlint/load/src/load.ts:25:17)
    at async main (/Users/zerdox/p/zerdox/zerdox.dev/node_modules/.pnpm/@commitlint+cli@17.3.0/node_modules/@commitlint/cli/src/cli.ts:214:17)
husky - commit-msg hook exited with code 1 (error)

So currently commitlint doesn't support .(ts|cts|mts|js|mjs) configs...

Neither to me.

It seems to be a bug related to ts-node, and it seems to be unsolved yet, right now I had to remove "type": "module" from package.json, but It should not be necessary.

Is there any development on this?

#3461 might help. It was just merged but not yet released.
It would be pretty enough!

Thank you!

SalahAdDin · 2023-01-20T19:59:47Z

#3461 might help. It was just merged but not yet released.

At least for me, It solved the problem.

escapedcat · 2023-01-21T09:22:10Z

@SalahAdDin Thanks for your feedback. Let's close this for now.

DamianGlowala · 2023-09-29T13:22:37Z

The issue persists, not sure why this got closed. Adding support for .cjs is a different concern and not a solution to what this issue describes.

I have a commitlint.config.ts file with package.json containing "type": "module" and receive the exact error mentioned by the author.

(Renaming file to commitlint.config.cts works fine.)

ZerdoX-x · 2023-09-30T21:21:53Z

Yep. Thanks for raising this up. I would also like commitlint to respect "type": "module" I set without switching from default .js/.ts extension.

escapedcat · 2023-10-01T09:57:18Z

Happy for a PR

alextnetto · 2023-10-11T13:24:02Z

I changed module.exports = to export default and it worked for me.

ZerdoX-x · 2023-10-19T15:39:53Z

@alextnetto can confirm that @commitlint/cli@17.7.2

with following contents of commitlint.config.ts

import type { UserConfig } from "@commitlint/types";

const config: UserConfig = {
	extends: ["@commitlint/config-conventional"],
};

export default config;

still throws an error:

/project/node_modules/.pnpm/ts-node@10.9.1_@types+node@20.8.4_typescript@5.2.2/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: /project/commitlint.config.ts
require() of ES modules is not supported.
require() of /home/zerdox/projects/job/imi/tonna_company-profile/commitlint.config.ts from /project/node_modules/.pnpm/cosmiconfig-typescript-loader@4.4.0_@types+node@20.5.1_cosmiconfig@8.3.6_ts-node@10.9.1_typescript@5.2.2/node_modules/cosmiconfig-typescript-loader/dist/cjs/index.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 /project/package.json.

    at createErrRequireEsm (/project/node_modules/.pnpm/ts-node@10.9.1_@types+node@20.8.4_typescript@5.2.2/node_modules/ts-node/dist-raw/node-internal-errors.js:46:15)
    at assertScriptCanLoadAsCJSImpl (/projects/node_modules/.pnpm/ts-node@10.9.1_@types+node@20.8.4_typescript@5.2.2/node_modules/ts-node/dist-raw/node-internal-modules-cjs-loader.js:584:11)
    at Object.require.extensions.<computed> [as .ts] (/project/node_modules/.pnpm/ts-node@10.9.1_@types+node@20.8.4_typescript@5.2.2/node_modules/ts-node/src/index.ts:1610:5)
    at Module.load (node:internal/modules/cjs/loader:1119:32)
    at Function.Module._load (node:internal/modules/cjs/loader:960:12)
    at Module.require (node:internal/modules/cjs/loader:1143:19)
    at require (node:internal/modules/cjs/helpers:119:18)
    at /projects/node_modules/.pnpm/cosmiconfig-typescript-loader@4.4.0_@types+node@20.5.1_cosmiconfig@8.3.6_ts-node@10.9.1_typescript@5.2.2/node_modules/cosmiconfig-typescript-loader/dist/cjs/index.js:59:22
    at Explorer.#loadConfiguration (/project/node_modules/.pnpm/cosmiconfig@8.3.6_typescript@5.2.2/node_modules/cosmiconfig/src/Explorer.ts:113:22)
    at Explorer.#readConfiguration (/projects/node_modules/.pnpm/cosmiconfig@8.3.6_typescript@5.2.2/node_modules/cosmiconfig/src/Explorer.ts:85:36) {
  name: '_TypeScriptCompileError',
  filepath: '/project/commitlint.config.ts'
}

Though I tried .js file with no types in ESM format and it worked just fine. By looking at previous error I cannot say that this is error caused by commitlint. Now I am not sure what is the state of this issue 🤔

The issue persists, not sure why this got closed. Adding support for .cjs is a different concern and not a solution to what this issue describes.

@DamianGlowala can you confirm that now commitlint .js config with ESM "just works"?

Maybe it's issue with cosmic config or ts loader itself? From where this difference between .ts and .js occurs? I wish I had some time to experiment with cosmiconfig.

UPD: Oh.. this is probably related to already mentioned TypeStrong/ts-node#1007 issue. So.. This can be closed now? @escapedcat what do you think?

escapedcat · 2023-10-20T11:38:31Z

@ZerdoX-x thanks for digging and confirming. If there's nothing we can do on our side we could close this again.

ZerdoX-x · 2023-10-26T11:35:25Z

I think yes, this can be closed, no response from other guys within a week. I am sure it's blocked by ts-node issue mentioned above

@escapedcat

alextnetto · 2023-10-26T12:22:37Z

@ZerdoX-x For .js you can use this on the config file.

export default { extends: ['@commitlint/config-conventional'] };

For me, it worked fine after that.

ZerdoX-x · 2023-10-26T13:08:59Z

@alextnetto yep, I know. but originally the issue about .ts file.

Personally using

// @ts-check

/* TODO: migrate from .js to .ts when
 * https://github.com/TypeStrong/ts-node/issues/1007
 * gets resolved.
 */

/** @typedef { import("@commitlint/types").UserConfig } */
export default {
	extends: ["@commitlint/config-conventional"],
};

.ts issue still exists but commitlint and cosmiconfig just require ts-node issue mentioned above to be resolved

newives · 2023-11-12T08:19:46Z

may be related to this cosmiconfig/cosmiconfig#312

pauliesnug · 2023-11-12T23:05:34Z

may be related to this cosmiconfig/cosmiconfig#312

@newives yes, i got this same error and the issue is cosmiconfig since it require()s the config, the craetor says it will be fixed so commitlint needs to update it once its fixed.

pauliesnug · 2023-11-12T23:07:56Z

for now, we can just set a package resolution override to "cosmiconfig": "9.0.0-alpha.3"

newives · 2023-11-14T14:38:33Z

stylelint/stylelint#7329 seems to have fixed the problem. I don’t know if it helps.

joberstein · 2023-11-16T04:13:30Z

Is this still an error with commitlint@18.2.0? ts-node was removed as a dependency with: v18.1.0...v18.2.0

newives · 2023-11-16T04:18:21Z

It is estimated that #3776 has been fixed. If possible, publish a version so I can test it.

escapedcat · 2023-11-16T04:28:52Z

https://github.com/conventional-changelog/commitlint/releases/tag/v18.4.2

newives · 2023-11-16T05:17:17Z

@joberstein Very nicely done❤️
I tested commitlint.config files ending with .js and .ts and using the esm syntax export default {} and they all worked fine

pauliesnug · 2023-11-17T00:03:07Z

Thank you very much!

masabbasi · 2024-01-15T11:01:53Z

I changed module.exports = to export default and it worked for me.

Thankful. It worked for me.

rolznz · 2024-09-01T08:49:54Z

Updating commitlint cli fixed this for me, also hi @escapedcat ! 😁

escapedcat added bug help wanted labels Jun 24, 2022

siuangie91 mentioned this issue Jul 10, 2022

chore: setup conventional commits siuangie91/svelte-pokedex#8

Merged

yudi-azvd mentioned this issue Aug 9, 2022

chore: adiciona husky com eslint UnBArqDsw2022-1/2022.1_G4_FluxoAgil-web#19

Merged

This comment was marked as duplicate.

Sign in to view

escapedcat closed this as completed Jan 21, 2023

escapedcat reopened this Sep 29, 2023

escapedcat closed this as completed Nov 16, 2023

escapedcat mentioned this issue Jan 15, 2024

fix: use ESM for cli #3642

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ERR_REQUIRE_ESM when using Node.js ESM in tandem with TypeScript config (commitlint.config.ts) #3251

ERR_REQUIRE_ESM when using Node.js ESM in tandem with TypeScript config (commitlint.config.ts) #3251

shian15810 commented Jun 23, 2022 •

edited

Loading

escapedcat commented Jun 24, 2022

erayaydin commented Jul 3, 2022

jjbell150 commented Aug 19, 2022

This comment was marked as duplicate.

ZerdoX-x commented Dec 26, 2022

escapedcat commented Dec 26, 2022

SalahAdDin commented Dec 26, 2022 •

edited

Loading

SalahAdDin commented Jan 20, 2023

escapedcat commented Jan 21, 2023

DamianGlowala commented Sep 29, 2023 •

edited

Loading

ZerdoX-x commented Sep 30, 2023

escapedcat commented Oct 1, 2023

alextnetto commented Oct 11, 2023

ZerdoX-x commented Oct 19, 2023 •

edited

Loading

escapedcat commented Oct 20, 2023

ZerdoX-x commented Oct 26, 2023

alextnetto commented Oct 26, 2023

ZerdoX-x commented Oct 26, 2023 •

edited

Loading

newives commented Nov 12, 2023

pauliesnug commented Nov 12, 2023 •

edited

Loading

pauliesnug commented Nov 12, 2023

newives commented Nov 14, 2023

joberstein commented Nov 16, 2023

newives commented Nov 16, 2023

escapedcat commented Nov 16, 2023

newives commented Nov 16, 2023

pauliesnug commented Nov 17, 2023

masabbasi commented Jan 15, 2024

rolznz commented Sep 1, 2024

ERR_REQUIRE_ESM when using Node.js ESM in tandem with TypeScript config (commitlint.config.ts) #3251

ERR_REQUIRE_ESM when using Node.js ESM in tandem with TypeScript config (commitlint.config.ts) #3251

Comments

shian15810 commented Jun 23, 2022 • edited Loading

Expected Behavior

Current Behavior

Affected packages

Possible Solution

Steps to Reproduce (for bugs)

Context

Your Environment

escapedcat commented Jun 24, 2022

erayaydin commented Jul 3, 2022

jjbell150 commented Aug 19, 2022

This comment was marked as duplicate.

ZerdoX-x commented Dec 26, 2022

escapedcat commented Dec 26, 2022

SalahAdDin commented Dec 26, 2022 • edited Loading

SalahAdDin commented Jan 20, 2023

escapedcat commented Jan 21, 2023

DamianGlowala commented Sep 29, 2023 • edited Loading

ZerdoX-x commented Sep 30, 2023

escapedcat commented Oct 1, 2023

alextnetto commented Oct 11, 2023

ZerdoX-x commented Oct 19, 2023 • edited Loading

escapedcat commented Oct 20, 2023

ZerdoX-x commented Oct 26, 2023

alextnetto commented Oct 26, 2023

ZerdoX-x commented Oct 26, 2023 • edited Loading

newives commented Nov 12, 2023

pauliesnug commented Nov 12, 2023 • edited Loading

pauliesnug commented Nov 12, 2023

newives commented Nov 14, 2023

joberstein commented Nov 16, 2023

newives commented Nov 16, 2023

escapedcat commented Nov 16, 2023

newives commented Nov 16, 2023

pauliesnug commented Nov 17, 2023

masabbasi commented Jan 15, 2024

rolznz commented Sep 1, 2024

shian15810 commented Jun 23, 2022 •

edited

Loading

SalahAdDin commented Dec 26, 2022 •

edited

Loading

DamianGlowala commented Sep 29, 2023 •

edited

Loading

ZerdoX-x commented Oct 19, 2023 •

edited

Loading

ZerdoX-x commented Oct 26, 2023 •

edited

Loading

pauliesnug commented Nov 12, 2023 •

edited

Loading