Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: prefix built-in node module imports #6236

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

slagiewka
Copy link

Since v5 relies on node >= 18, this is now possible (since v16, v14.18.0 12).

It's functionally irrelevant:

  1. It's not required for CJS nor ESM (with a few exceptions 3)
  2. It has no performance promises

However, there are upsides to this approach:

  1. It brings clear boundaries to what's a built-in and what's an external dependency
  2. It reduces the risk of importing unwanted deps where a built-in is expected
  3. It's slightly more interoperable with other JS runtimes that provide node compatibility4, albeit only during development. Once imported from npm, built-ins are assumed.

Footnotes

  1. https://nodejs.org/docs/latest-v22.x/api/modules.html#built-in-modules

  2. https://github.com/nodejs/node/pull/37246

  3. https://nodejs.org/api/modules.html#built-in-modules-with-mandatory-node-prefix

  4. https://docs.deno.com/runtime/fundamentals/node/#using-node's-built-in-modules

Since v5 relies on node >= 18, this is now possible (since v16, v14.18.0
[^1][^2]).

It's functionally irrelevant:
1. It's not required for CJS nor ESM (with a few exceptions [^3])
2. It has no performance promises

However, there are upsides to this approach:
1. It brings clear boundaries to what's a built-in and what's an
external dependency
2. It reduces the risk of importing unwanted deps where a built-in is
expected
3. It's slightly more interoperable with other JS runtimes that provide
node compatibility[^4], albeit only during development. Once imported
from npm, built-ins are assumed.

[^1]:https://nodejs.org/docs/latest-v22.x/api/modules.html#built-in-modules
[^2]:nodejs/node#37246
[^3]:https://nodejs.org/api/modules.html#built-in-modules-with-mandatory-node-prefix
[^4]:https://docs.deno.com/runtime/fundamentals/node/#using-node's-built-in-modules
Copy link
Member

@UlisesGascon UlisesGascon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work @slagiewka! I like the idea, let's see what other @expressjs/express-tc members things about it :)

Copy link
Contributor

@carpasse carpasse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants