Fix: Use `node`-prefixed requires for builtins #2170

sgammon · 2024-03-31T01:06:12Z

Pull Request

Problem

I want to use a Commander-based CLI tool from Deno, as explained in #2169

Solution

Fixes and closes #2169 by using Node-prefixed imports.

Note: Node-prefixed imports are supported on Node 16+, so this may break older apps on very old versions of Node. As a result I would suggest a major version bump to signal a compatibility change. Node 16 has reached EOL, so people really should be upgrading if they can.

No code was changed in Commander itself; just imports.

ChangeLog

Use node:-prefixed requires; this may break compatibility with older versions of Node (up to 15). Please upgrade Node, bundle your app with rewriting to remove the node: prefix on requires, or avoid upgrading Commander if Node cannot be upgraded.

Fixes and closes tj#2169 by using Node-prefixed imports. Signed-off-by: Sam Gammon <sam@elide.dev>

sgammon · 2024-03-31T01:06:21Z

lib/command.js

-const EventEmitter = require('events').EventEmitter;
-const childProcess = require('child_process');
-const path = require('path');
-const fs = require('fs');
-const process = require('process');
+const EventEmitter = require('node:events').EventEmitter;
+const childProcess = require('node:child_process');
+const path = require('node:path');
+const fs = require('node:fs');
+const process = require('node:process');


the whole pr

- feat: support all popular js runtimes - patches for `glob`, `minipass`, and `path-scurry` - upstream prs (listed below) - test entrypoint commands - test: add test entrypoints for each major runtime - test: add scripts to test entrypoint with each major runtime - chore: sync lockfiles Related Issues - isaacs/node-glob#580 - isaacs/path-scurry#16 - isaacs/minipass#54 - tj/commander.js#2169 Upstream PRs - isaacs/node-glob#581 - isaacs/minipass#55 - isaacs/path-scurry#17 - tj/commander.js#2170 Signed-off-by: Sam Gammon <sam@elide.dev>

* feat: support all runtimes - feat: support all popular js runtimes - patches for `glob`, `minipass`, and `path-scurry` - upstream prs (listed below) - test entrypoint commands - test: add test entrypoints for each major runtime - test: add scripts to test entrypoint with each major runtime - chore: sync lockfiles Related Issues - isaacs/node-glob#580 - isaacs/path-scurry#16 - isaacs/minipass#54 - tj/commander.js#2169 Upstream PRs - isaacs/node-glob#581 - isaacs/minipass#55 - isaacs/path-scurry#17 - tj/commander.js#2170 Signed-off-by: Sam Gammon <sam@elide.dev> * chore: version bump → `1.0.3` Signed-off-by: Sam Gammon <sam@elide.ventures> --------- Signed-off-by: Sam Gammon <sam@elide.dev> Signed-off-by: Sam Gammon <sam@elide.ventures>

shadowspawn · 2024-04-02T04:30:34Z

Commander v12 requires node v18 or higher, so node compatibility for using the node: protocol is not an issue.

commander.js/package.json

Line 77 in 83c3f4e

"node": ">=18"

shadowspawn · 2024-04-06T06:09:28Z

This issue only shows up because of bundling then running with Deno, and the change to fix it is only likely to break similar workflows involving transpiling and bundling tools not supporting the "node:" prefix for built-in modules.

The node: prefix for core modules has been available in Node.js since (at least) v16.0.0

So I think normal uses of Commander won't be affected by this change, and if it breaks some more exotic uses then we will roll it back.

shadowspawn

LGTM

abetomo

👍

Adopt changes from tj/commander.js#2170 Signed-off-by: Sam Gammon <sam@elide.ventures>

* fix: postinstall script Signed-off-by: Sam Gammon <sam@elide.ventures> * chore: version bump → `1.0.4` Signed-off-by: Sam Gammon <sam@elide.ventures> * chore: update to commander.js `develop` branch Adopt changes from tj/commander.js#2170 Signed-off-by: Sam Gammon <sam@elide.ventures> * fix: disable distcheck (tmp) Signed-off-by: Sam Gammon <sam@elide.ventures> * chore: update all node deps Signed-off-by: Sam Gammon <sam@elide.ventures> --------- Signed-off-by: Sam Gammon <sam@elide.ventures>

shadowspawn · 2024-05-18T23:10:17Z

Released in v12.1.0

sgammon · 2024-05-19T00:30:58Z

@shadowspawn Thank you for the ping! I'll go ahead and adopt. 🥳

Fix: Use node-prefixed requires for builtins

9df621d

Fixes and closes tj#2169 by using Node-prefixed imports. Signed-off-by: Sam Gammon <sam@elide.dev>

sgammon commented Mar 31, 2024

View reviewed changes

sgammon mentioned this pull request Mar 31, 2024

feat: support all runtimes sgammon/hashlock#29

Merged

shadowspawn approved these changes Apr 6, 2024

View reviewed changes

abetomo changed the base branch from master to develop April 6, 2024 23:57

abetomo approved these changes Apr 6, 2024

View reviewed changes

abetomo merged commit f7b8475 into tj:develop Apr 6, 2024
8 checks passed

shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Apr 7, 2024

sgammon added a commit to sgammon/hashlock that referenced this pull request Apr 15, 2024

chore: update to commander.js develop branch

0d5c08c

Adopt changes from tj/commander.js#2170 Signed-off-by: Sam Gammon <sam@elide.ventures>

shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label May 18, 2024

Exkaleburx mentioned this pull request Jun 8, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 Exkaleburx/chakra-ui#42

Open

viqueen mentioned this pull request Jun 8, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 viqueen/devbox#124

Closed

nicomt mentioned this pull request Jun 9, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 nicomt/ckron#84

Open

calvin-kimani mentioned this pull request Jun 9, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 calvin-kimani/sparta#2

Open

StemmlerSisters mentioned this pull request Jun 9, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 StemmlerSisters/smee-client#3

Open

Noggling mentioned this pull request Jun 10, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 equinor/cc-components#1044

Closed

This was referenced Jun 19, 2024

[Snyk] Upgrade commander from 8.3.0 to 12.1.0 YoutacRandS-VA/NativeScript#4

Open

[Snyk] Upgrade commander from 1.3.2 to 12.1.0 YoutacRandS-VA/cjdmaid#1

Open

schwer mentioned this pull request Jul 6, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 schwer/graphql-to-openapi#526

Closed

JhayceFrancis mentioned this pull request Jul 16, 2024

[Snyk] Upgrade commander from 11.1.0 to 12.1.0 JhayceFrancis/socket-link.js#7

Open

WontonSam mentioned this pull request Jul 16, 2024

[Snyk] Upgrade commander from 2.20.3 to 12.1.0 WontonSam/chromepet#4

Open

Ramyromel mentioned this pull request Aug 10, 2024

[Snyk] Upgrade commander from 3.0.2 to 12.1.0 Ramyromel/bsc#5

Merged

Exkaleburx mentioned this pull request Sep 6, 2024

[Snyk] Upgrade: commander, prettier Exkaleburx/chakra-ui#185

Open

q1blue mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: , , , axios, commander, consola, koa-body, koa-router, lru-cache, luxon, mysql2, node-sql-parser, octokit, p-queue, pinyin, prom-client, reflect-metadata, tiny-async-pool https-quantumblockchainai-atlassian-net/ossinsight#848

Open

AKJUS mentioned this pull request Sep 12, 2024

[Snyk] Upgrade commander from 12.0.0 to 12.1.0 AKJUS/amphtml#3

Open

q1blue mentioned this pull request Sep 13, 2024

[Snyk] Upgrade: , , , axios, commander, consola, koa-body, koa-router, lru-cache, luxon, mysql2, node-sql-parser, octokit, p-queue, pinyin, prom-client, reflect-metadata, tiny-async-pool https-quantumblockchainai-atlassian-net/ossinsight#859

Open

q1blue mentioned this pull request Sep 20, 2024

[Snyk] Upgrade: , , , axios, commander, consola, koa-body, koa-router, lru-cache, luxon, mysql2, node-sql-parser, octokit, p-queue, pinyin, prom-client, reflect-metadata, tiny-async-pool https-quantumblockchainai-atlassian-net/ossinsight#873

Open

WontonSam mentioned this pull request Sep 22, 2024

[Snyk] Upgrade: , node-fetch, , commander, dotenv, open WontonSam/chicommerce#564

Open

q1blue mentioned this pull request Sep 22, 2024

[Snyk] Upgrade: , , , axios, commander, consola, koa-body, koa-router, lru-cache, luxon, mysql2, node-sql-parser, octokit, p-queue, pinyin, prom-client, reflect-metadata, tiny-async-pool https-quantumblockchainai-atlassian-net/ossinsight#881

Open

snyk-io bot mentioned this pull request Sep 23, 2024

[Snyk] Upgrade: commander, koa-compress, ws SherfeyInv/chii#2

Open

jihaui mentioned this pull request Sep 25, 2024

[Snyk] Upgrade commander from 8.3.0 to 12.1.0 jihaui/gh-migration-analyzer#4

Open

WontonSam mentioned this pull request Oct 15, 2024

[Snyk] Upgrade commander from 9.5.0 to 12.1.0 WontonSam/chicommerce#863

Open

lholmquist mentioned this pull request Oct 31, 2024

[Snyk] Upgrade commander from 11.0.0 to 12.1.0 nodeshift/faas-js-runtime#372

Open

snyk-io bot mentioned this pull request Nov 9, 2024

[Snyk] Upgrade commander from 2.1.0 to 12.1.0 doperiddle/proof-of-assets#1

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Use `node`-prefixed requires for builtins #2170

Fix: Use `node`-prefixed requires for builtins #2170

sgammon commented Mar 31, 2024

sgammon Mar 31, 2024

shadowspawn commented Apr 2, 2024

shadowspawn commented Apr 6, 2024 •

edited

Loading

shadowspawn left a comment

abetomo left a comment

shadowspawn commented May 18, 2024

sgammon commented May 19, 2024

Fix: Use node-prefixed requires for builtins #2170

Fix: Use node-prefixed requires for builtins #2170

Conversation

sgammon commented Mar 31, 2024

Pull Request

Problem

Solution

ChangeLog

sgammon Mar 31, 2024

Choose a reason for hiding this comment

shadowspawn commented Apr 2, 2024

shadowspawn commented Apr 6, 2024 • edited Loading

shadowspawn left a comment

Choose a reason for hiding this comment

abetomo left a comment

Choose a reason for hiding this comment

shadowspawn commented May 18, 2024

sgammon commented May 19, 2024

Fix: Use `node`-prefixed requires for builtins #2170

Fix: Use `node`-prefixed requires for builtins #2170

shadowspawn commented Apr 6, 2024 •

edited

Loading