Skip to content

debug causes npm to always issue an experimental ESM warning in node 23 #975

Description

@ljharb

Specifically,

const supportsColor = require('supports-color');
is triggering it. See also nodejs/node#55338 (comment) and nodejs/node#55397.

I'm not sure the best solution here. One is to use optional peer deps to force supports-color to be < 9; another is to do monkeypatching shenanigans around that require to suppress the experimental warning; I'm sure there's more.

Activity

  1. joyeecheung commented on Oct 16, 2024

    @joyeecheung

    The warning can also be temporarily disabled using process.noDeprecation = true (it's kind of an abuse because it's an experimental warning, not a deprecation warning, and it's kind of a bug that it affects the experimental warnings, but hey the bug is out there already). A slightly saner solution can be checking whether process.version starts with v23 (the warning will be restricted to code not coming from node_modules on v22, and will probably be gone by 24).

  2. MikeMcC399 commented on Oct 20, 2024

    @MikeMcC399

    supports-color@9.0.0, released in Apr 2021, was the first version to use pure ESM.

    This issue affects any project where supports-color >= 9.0.0 (ESM only) is installed together with debug. It is not restricted to npm.

    For instance, on Ubuntu 24.04.1 LTS, Node.js 23.0.0, npm 10.9.0, executing the following:

    git clone https://github.com/cypress-io/github-action
    cd github-action
    npm ci
    node src/ping-cli.js https://example.cypress.io

    not only shows the ExperimentalWarning from npm ci, it also shows the warning from

    node src/ping-cli.js https://example.cypress.io

    which is not using npm at all:

    $ node src/ping-cli.js https://example.cypress.io
    pinging url https://example.cypress.io for 30 seconds
    (node:5900) ExperimentalWarning: Support for loading ES Module in require() is an experimental feature and might change at any time
    (Use `node --trace-warnings ...` to show where the warning was created)
    

    https://github.com/cypress-io/github-action is configured with supports-color@9.3.1, i.e. a pure ESM version.

  3. ljharb commented on Oct 20, 2024

    @ljharb
    Author

    @MikeMcC399 however, it'd only trigger on projects that require that version, which virtually nobody would do, except in this package's case where it's treated like an implicit optional dep - requiring < 9, and importing any version, wouldn't trigger the warning.

  4. MikeMcC399 commented on Oct 25, 2024

    @MikeMcC399

    Under Node.js v23.1.0 the warning provides additional debugging information which confirms the previous analysis:

    $ npm view npm version
    (node:13088) ExperimentalWarning: CommonJS module /home/mike/n/lib/node_modules/npm/node_modules/debug/src/node.js is loading ES Module /home/mike/n/lib/node_modules/npm/node_modules/supports-color/index.js using require().
    Support for loading ES Module in require() is an experimental feature and might change at any time
    (Use `node --trace-warnings ...` to show where the warning was created)
    10.9.0
    
  5. Qix- commented on Nov 4, 2024

    @Qix-
    Member

    use optional peer deps

    This is probably fine; I don't think that was around when I implemented the optional dependency stuff. PR welcome and I'll cut a patch release ASAP (especially if it's within the next 48 hours, otherwise might be after Nov 16th at some point. Some last minute traveling happening for urgent reasons. Ping me here if it falls through the cracks).

  6. wellwelwel commented on Nov 4, 2024

    @wellwelwel

    @Qix-, first of all, thanks for your attention to this issue.

    I would really appreciate it if you could take a look at npm/cli#7857 (comment), since it would directly implicate this project and, naturally, npm/cli (in a good way).

    I can't say what the community thinks about this yet, but it's a solution that seems both user-friendly and easy to implement (locally, everything is practically ready), plus that wouldn't overload the team of any of the involved projects (debug, supports-color, and npm/cli).

  7. Qix- commented on Nov 20, 2024

    @Qix-
    Member

    @stefee kindly submitted a PR, but the regressions stated here are a bit bothersome.

    The only other "correct" alternative is to switch to ESM-only and use import, but I'd imagine that doesn't really solve problems people are facing today.


    There's a less-nice alternative. Start without any extended color support, fire off an async import() and then once it completes retroactively enable extended color support. The first few log messages will have the basic colors but switch later on. I don't know how terrible of an idea that is, though.

  8. jonkoops commented on Nov 20, 2024

    @jonkoops

    Another option would be to introduce a build system to ship debug as a dual-module package, so both ESM and CJS versions are included. This would allow users seeing this warning to adopt ESM, which would then remove the warning.

  9. backflip commented on Nov 20, 2024

    @backflip

    In case people are not following this linked issue: There's a possibility the warning will be hidden in Node 23, too: nodejs/node#55217 (comment)

  10. Qix- commented on Nov 20, 2024

    @Qix-
    Member

    I'm not super keen on adding a build system, personally. Debug shouldn't need one; it's a trivial package. If every package ends up needing a build system then I'm not sure what that says about the Node.js ecosystem.

    Perhaps an unpopular opinion.

  11. jonkoops commented on Nov 20, 2024

    @jonkoops

    Totally agree, I am of the personal opinion that we need to get back to simple packages that are aligned across the ecosystem, just wanted to throw out the option. Since it looks like this warning will be removed from Node.js it might be worth it to just wait this one out, as it might resolve itself.

    That said, since all Node.js LTS versions will soon have support for importing ESM from CommonJS it might be worth it to then consider adopting ESM as well. But this is likely an entirely separate discussion.

  12. ljharb commented on Nov 20, 2024

    @ljharb
    Author

    It’ll be possibly years before all LTS versions support that.

  13. jonkoops commented on Nov 20, 2024

    @jonkoops

    Looks like at least 22.x is getting a backport (see nodejs/node#52697), and I was under the impression that the same would be done for 20.x and even 18.x but I could be mistaken. 18.x will be end-of-life the first half of next year as well.

  14. Qix- commented on Nov 20, 2024

    @Qix-
    Member

    I guess another way of handling this is to simply vendor in supports-color to the codebase and modify it to be CJS, though as a maintainer of both packages I feel like I'd be stabbing myself in the back.

    Feels very "putting a stick in your own bicycle spokes meme".

  15. jonkoops commented on Nov 20, 2024

    @jonkoops

    So at the very least 20.x will have a backport (nodejs/node#52697 (comment)). Might be worth a semver major once 18.x reaches EOL.

  16. ljharb commented on Nov 21, 2024

    @ljharb
    Author

    Unfortunately the stick was making it ESM-only :-/

  17. joyeecheung commented on Nov 21, 2024

    @joyeecheung

    FYI for v22.x the warning would be suppressed when the require() is coming from node_modules.

    For v23 we are considering the same but complications apply due to LTS policy nodejs/node#55217 (comment)

  18. MikeMcC399 commented on Dec 10, 2024

    @MikeMcC399

    @joyeecheung

    FYI for v22.x the warning would be suppressed when the require() is coming from node_modules.

    For v23 we are considering the same but complications apply due to LTS policy nodejs/node#55217 (comment)

    I'm seeing this implemented now in Node.js v23.4.0 🚀

  19. MikeMcC399 commented on Dec 10, 2024

    @MikeMcC399

    @ljharb

    The repro steps I gave in #975 (comment) are no longer showing any warning when run under Node.js v23.4.0:

    git clone https://github.com/cypress-io/github-action
    cd github-action
    npm ci
    node src/ping-cli.js https://example.cypress.io
    npm ls debug
    node -v

    Do you consider the issue fixed now?

  20. ljharb commented on Dec 10, 2024

    @ljharb
    Author

    The issue is fixed in node v23.4.0, yes. It would still be good to fix it for node v23.0 - v23.3, but I'll close it in the meantime.

  21. pinned this issue on Dec 30, 2024
  22. unpinned this issue on Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions