require() of ES Module /xxx/commitlint.config.js from /xxx/node_modules/cosmiconfig/dist/loaders.js not supported. Instead change the require of commitlint.config.js in /xxx/node_modules/cosmiconfig/dist/loaders.js to a dynamic import() which is available in all CommonJS modules.

[pfdgithub]

Expected Behavior

When I upgrade commitlint to the latest version in an ESModule project and trigger the commit-msg hook, the following error will appear:

> git -c user.useConfigOnly=true commit --quiet --allow-empty-message --file -
[STARTED] Preparing lint-staged...
[COMPLETED] Preparing lint-staged...
[STARTED] Running tasks for staged files...
[STARTED] lint-staged.config.js — 76 files
[STARTED] src/**/* — 59 files
[STARTED] prettier -l -w
[COMPLETED] prettier -l -w
[COMPLETED] src/**/* — 59 files
[COMPLETED] lint-staged.config.js — 76 files
[COMPLETED] Running tasks for staged files...
[STARTED] Applying modifications from tasks...
[COMPLETED] Applying modifications from tasks...
[STARTED] Cleaning up temporary files...
[COMPLETED] Cleaning up temporary files...
/xxx/node_modules/cosmiconfig/dist/loaders.js:32
    if (parseJson === undefined) {
                                                          ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /xxx/commitlint.config.js from /xxx/node_modules/cosmiconfig/dist/loaders.js not supported.
Instead change the require of commitlint.config.js in /xxx/node_modules/cosmiconfig/dist/loaders.js to a dynamic import() which is available in all CommonJS modules.
    at module.exports (/xxx/node_modules/import-fresh/index.js:32:59)
    at loadJsSync (/xxx/node_modules/cosmiconfig/dist/loaders.js:17:12)
    at #loadConfiguration (/xxx/node_modules/cosmiconfig/dist/Explorer.js:92:30)
    at #readConfiguration (/xxx/node_modules/cosmiconfig/dist/Explorer.js:77:80)
    at async search (/xxx/node_modules/cosmiconfig/dist/Explorer.js:44:40)
    at async Explorer.search (/xxx/node_modules/cosmiconfig/dist/Explorer.js:71:20)
    at async loadConfig (/xxx/node_modules/@commitlint/load/lib/utils/load-config.js:45:19)
    at async load (/xxx/node_modules/@commitlint/load/lib/load.js:19:20)
    at async main (/xxx/node_modules/@commitlint/cli/lib/cli.js:189:20) {
  code: 'ERR_REQUIRE_ESM',
  filepath: '/xxx/commitlint.config.js'
}

Node.js v18.17.0
husky - commit-msg hook exited with code 1 (error)

package.json

{
  "type": "module",
  "devDependencies": {
    "@commitlint/cli": "^18.4.1",
    "@commitlint/config-conventional": "^18.4.0"
  }
}

commit-msg

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"

commitlint.config.js

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

cosmiconfig version

% npm list cosmiconfig

├─┬ @commitlint/cli@18.4.1
│ └─┬ @commitlint/load@18.4.1
│   ├─┬ cosmiconfig-typescript-loader@5.0.0
│   │ └── cosmiconfig@8.3.6 deduped
│   └── cosmiconfig@8.3.6
└─┬ @svgr/rollup@8.1.0
  ├─┬ @svgr/core@8.1.0
  │ └── cosmiconfig@8.3.6 deduped
  └─┬ @svgr/plugin-svgo@8.1.0
    └── cosmiconfig@8.3.6 deduped

Current Behavior

No response

Affected packages

• cli
• core
• prompt
• config-angular

Possible Solution

No response

Steps to Reproduce

1. First step
2. Second step

Context

No response

commitlint --version

@commitlint/cli@18.4.1

git --version

git version 2.39.2 (Apple Git-143)

node --version

v18.17.0

[escapedcat]

@joberstein you got an idea?

[escapedcat]

Can you try if this works with the latest node v18? (Node.js 18.18.2)

[pfdgithub]

Can you try if this works with the latest node v18? (Node.js 18.18.2)

Still not working in node 18.18.2

> git -c user.useConfigOnly=true commit --quiet --allow-empty-message --file -
→ No staged files match any configured task.
/xxx/node_modules/cosmiconfig/dist/loaders.js:32
    if (parseJson === undefined) {
                                                          ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /xxx/commitlint.config.js from /xxx/node_modules/cosmiconfig/dist/loaders.js not supported.
Instead change the require of commitlint.config.js in /xxx/node_modules/cosmiconfig/dist/loaders.js to a dynamic import() which is available in all CommonJS modules.
    at module.exports (/xxx/node_modules/import-fresh/index.js:32:59)
    at loadJsSync (/xxx/node_modules/cosmiconfig/dist/loaders.js:17:12)
    at #loadConfiguration (/xxx/node_modules/cosmiconfig/dist/Explorer.js:92:30)
    at #readConfiguration (/xxx/node_modules/cosmiconfig/dist/Explorer.js:77:80)
    at async search (/xxx/node_modules/cosmiconfig/dist/Explorer.js:44:40)
    at async Explorer.search (/xxx/node_modules/cosmiconfig/dist/Explorer.js:71:20)
    at async loadConfig (/xxx/node_modules/@commitlint/load/lib/utils/load-config.js:45:19)
    at async load (/xxx/node_modules/@commitlint/load/lib/load.js:19:20)
    at async main (/xxx/node_modules/@commitlint/cli/lib/cli.js:189:20) {
  code: 'ERR_REQUIRE_ESM',
  filepath: '/xxx/commitlint.config.js'
}

Node.js v18.18.2
husky - commit-msg hook exited with code 1 (error)

[pfdgithub]

Maybe introduced in v18.4.0?

[escapedcat]

I guess so, yes. 18.3 working for you?

[pfdgithub]

I guess so, yes. 18.3 working for you?

Strangely, I deleted the node_modules and package-lock.json files and downgraded to versions @commitlint/cli@18.2.0 and @commitlint/config-conventional@18.1.0, which were the normal versions I used before, but I still get the error.

% npm list @commitlint/cli

└── @commitlint/cli@18.2.0

% npm list @commitlint/config-conventional

└── @commitlint/config-conventional@18.1.0

% npm list cosmiconfig                                                                          
├─┬ @commitlint/cli@18.2.0
│ └─┬ @commitlint/load@18.4.1
│   ├─┬ cosmiconfig-typescript-loader@5.0.0
│   │ └── cosmiconfig@8.3.6 deduped
│   └── cosmiconfig@8.3.6
└─┬ @svgr/rollup@8.1.0
  ├─┬ @svgr/core@8.1.0
  │ └── cosmiconfig@8.3.6 deduped
  └─┬ @svgr/plugin-svgo@8.1.0
    └── cosmiconfig@8.3.6 deduped

The problem seems to be with @commitlint/load

[escapedcat]

That's weird. Does v17 work?

[pfdgithub]

It can be determined that the problem lies in @commitlint/load, and it will be normal after downgrading to 18.2.0

[pfdgithub]

a2b65fc#diff-3e90d2800eb60d709cca92472b333763ede7d37114de0ce47a0fd25593f214c2R98

When type: module is specified in package.json, the .js file will be considered ESModule style and the CommonJS style loader cannot be used.

[escapedcat]

Thanks for the digging. Do you have time for a PR maybe?

[pfdgithub]

Sorry, PR3772 used the wrong email address

[joberstein]

@escapedcat @pfdgithub I'd like to simplify the original implementation for this - basically use the async loaders if dynamic await is supported (node > 20.8.0) OR config is an ESM module application. Otherwise, use the sync loaders. I almost have some additional tests ready to push to cover additional cases, and code changes are minor, similar to the PR. Unfortunately, this specific case can't be covered in the Jest tests; trying to use the dynamic import in node < 20.8.0 will cause a seg fault and prevent the test from finishing. But I was able to verify the change manually with linking to another repo.

I also noticed that the resolve extends package doesn't do well with ESM since it uses require to load additional extended config, but I wasn't able to get something working for that. I can make a new issue to address it since it's unrelated.