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. #3768

pfdgithub · 2023-11-13T08:29:03Z

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

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

escapedcat · 2023-11-13T08:47:49Z

@joberstein you got an idea?

escapedcat · 2023-11-13T08:49:33Z

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

pfdgithub · 2023-11-13T09:06:05Z

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 · 2023-11-13T09:09:51Z

Maybe introduced in v18.4.0?

escapedcat · 2023-11-13T09:11:14Z

I guess so, yes. 18.3 working for you?

pfdgithub · 2023-11-13T09:29:38Z

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 · 2023-11-13T09:32:33Z

That's weird. Does v17 work?

pfdgithub · 2023-11-13T09:34:08Z

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

pfdgithub · 2023-11-13T09:52:23Z

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 · 2023-11-13T09:54:23Z

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

pfdgithub · 2023-11-13T12:05:55Z

Sorry, PR3772 used the wrong email address

joberstein · 2023-11-15T06:07:04Z

@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.

escapedcat · 2023-11-15T07:44:38Z

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.

So people who use v20 should use at least use 20.8? Sounds good to me.
CI would pass, right?

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.

Is this part of or just #3705 maybe?

Thanks for all your work!

joberstein · 2023-11-16T01:04:13Z

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.

So people who use v20 should use at least use 20.8? Sounds good to me. CI would pass, right?

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.

Is this part of or just #3705 maybe?

Thanks for all your work!

Technically the async loaders will work in source code with other node versions, but for the purposes of the tests, the sync loaders should be used (this was also the previous behavior because before cosmiconfig 8.2.0, the async loaders used commonJS like the sync loaders do now). I've set up the tests to skip the ones that would cause Jest to crash.

The resolve-extends issue might be resolved by #3705; is that updating the entire package to use ESM? There may be similar test issues as the ones seen in the cosmiconfig update as a heads up.

escapedcat · 2023-11-16T03:18:14Z

The resolve-extends issue might be resolved by #3705; is that updating the entire package to use ESM?

That issue is just a reminder that commitlint in general should be switched to ESM. I opened this up because we already have dep updates being blocked by this (at least I think that's the case).

pfdgithub added the bug label Nov 13, 2023

This was referenced Nov 13, 2023

fix: detect esmodule project #3772

Closed

fix: detect esmodule project #3773

Closed

joberstein mentioned this issue Nov 16, 2023

Fix/3768: Consider ESM when selecting cosmiconfig loaders #3776

Merged

7 tasks

escapedcat closed this as completed in #3776 Nov 16, 2023

sheerlox mentioned this issue Nov 16, 2023

refactor!: convert library to ESM insurgent-lab/commitlint-config#99

Merged

HarukaYamamoto0 mentioned this issue May 4, 2024

fix: change commitlint.config.js file extension HarukaYamamoto0/locart#3

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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. #3768

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. #3768

pfdgithub commented Nov 13, 2023 •

edited

Loading

escapedcat commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

joberstein commented Nov 15, 2023

escapedcat commented Nov 15, 2023

joberstein commented Nov 16, 2023

escapedcat commented Nov 16, 2023

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. #3768

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. #3768

Comments

pfdgithub commented Nov 13, 2023 • edited Loading

Expected Behavior

Current Behavior

Affected packages

Possible Solution

Steps to Reproduce

Context

commitlint --version

git --version

node --version

escapedcat commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

escapedcat commented Nov 13, 2023

pfdgithub commented Nov 13, 2023

joberstein commented Nov 15, 2023

escapedcat commented Nov 15, 2023

joberstein commented Nov 16, 2023

escapedcat commented Nov 16, 2023

pfdgithub commented Nov 13, 2023 •

edited

Loading