fix(deps): upgrade commander #7008

serhalp · 2025-01-21T18:41:01Z

This is currently stacked on #7019.

TODO my solution to the "hidden" global options like --json that were redefined in some commands is resulting in the generated reference docs dropping those options from those commands... We need to either update the script to read from "help options" on the command object (at first glance it doesn't seem to be available...) or try a different approach (like removing these entirely from BaseCommand and defining them as regular options on the individual commands that do want them).

serhalp · 2025-01-21T18:53:10Z

src/commands/base-command.ts

-      .addOption(
-        new Option('--httpProxy [address]', 'Old, prefer --http-proxy. Proxy server address to route requests through.')
-          .default(process.env.HTTP_PROXY || process.env.HTTPS_PROXY)
-          .hideHelp(true),
-      )


It looks like there was an httpProxy option and an http-proxy option but these got accidentally(?) squashed into a duplicated httpProxy option in https://github.com/netlify/cli/pull/5816/files#diff-67082469659283bc342bd13f7e20570cb3d1bf5096aad88545a9ac4809d6083bL106-L140. The latest version of commander throws when you declare duplicate options.

What's extra confusing is the copy here implies that http-proxy was intended to be the new one but that's not where it landed 🤷🏼.

serhalp · 2025-01-21T18:54:06Z

src/lib/functions/runtimes/js/builders/netlify-lambda.ts

@@ -27,6 +27,7 @@ export const detectNetlifyLambda = async function ({ packageJson } = {}) {
      .option('-b, --babelrc [file]')
      .option('-t, --timeout [delay]')

+    program.allowExcessArguments()


The default behaviour changed in the commander upgrade. This opts back into the previous behaviour. We might consider changing at some point, but it didn't seem right to include this in this PR (and require us to cut a major).

(To be clear here, I ended up only upgrading to commander@12 after all. This behavioural change is in commander@13, but I left this here so we're ready for it, since it doesn't hurt.)

serhalp · 2025-01-21T19:03:55Z

src/commands/blobs/blobs.ts

-    .option('-o, --output <path>', 'Defines the filesystem path where the blob data should be persisted')
+    .option('-O, --output <path>', 'Defines the filesystem path where the blob data should be persisted')


-o is already used in the base command for --offline, so this was being quietly ignored (I tested it locally).

This is fine to be considered a patch change since it has never worked.

Caught by changes in commander upgrade: tj/commander.js#2055.

serhalp · 2025-01-21T19:14:21Z

src/commands/blobs/blobs.ts

-    .option('--json', `Output list contents as JSON`)
+    // The BaseCommand defines a `--json` option which is hidden from the help by default
+    .addHelpOption(new Option('--json', 'Output list contents as JSON'))


Same as above here, but in this case it's intentional. Just removing this line works, but then --json no longer shows up in ntl blobs:get --help. This solution seems to cover all the bases.

... and then same for all the command --offline cases

serhalp · 2025-01-22T13:59:18Z

src/commands/deploy/index.ts

-    .option('-o, --open', 'Open site after deploy', false)
+    .option('-O, --open', 'Open site after deploy', false)


Same here, there's already -o for --offline in the BaseCommand, so deploy -o wasn't working as intended. It just started an offline deploy which of course didn't work.

github-actions · 2025-01-23T20:27:23Z

📊 Benchmark results

Comparing with 8a51e34

Dependency count: 1,194 ⬆️ 2.01% increase vs. 8a51e34
Package size: 307 MB ⬇️ 2.94% decrease vs. 8a51e34
Number of ts-expect-error directives: 801 ⬇️ 0.37% decrease vs. 8a51e34

There's some sort of undocumented breaking visual change that's messing with snapshot tests.

It looks like there's some sort of change in inquirer-autocomplete-prompt and it's a can of worms to troubleshoot. This in turn prevents upgrading inquirer past v8.

This reverts commit 055a7b0.

It looks like there was an `httpProxy` option and an `http-proxy` option but these got accidentally(?) squashed into a duplicated `httpProxy` option in https://github.com/netlify/cli/pull/5816/files#diff-6708246L106-L140.

`-o` is already used in the base command for `--offline`, so this was being quietly ignored This can't be considered a breaking change as it has never worked. (I just tried it to be sure.) See tj/commander.js#2055.

See tj/commander.js#2055.

It's already used in the BaseCommand for `--offline`. This is not a breaking change, because this never worked as is. Same issue as in 9280c55.

It's already defined in the BaseCommand for `--offline`.

- `-r` was already used globally so this was being ignored - the camelCase version was using the same short option as the kebab-case, which isn't allowed

It was redefining the options over and over and over. The latest commander throws.

serhalp commented Jan 21, 2025

View reviewed changes

serhalp force-pushed the fix/upgrade-misc-deps branch 3 times, most recently from c3cdea8 to b807744 Compare January 21, 2025 21:30

serhalp commented Jan 22, 2025

View reviewed changes

serhalp mentioned this pull request Jan 22, 2025

chore: replatform docs site to Astro + Starlight #7012

Merged

serhalp force-pushed the fix/upgrade-misc-deps branch from b807744 to 4727ceb Compare January 23, 2025 20:26

serhalp force-pushed the fix/upgrade-misc-deps branch 3 times, most recently from 04372e6 to 0d11dde Compare January 23, 2025 22:10

talentlessguy mentioned this pull request Jan 29, 2025

Cleanup of the Netlify CLI e18e/ecosystem-issues#156

Open

serhalp mentioned this pull request Jan 31, 2025

fix(deps): upgrade 23 outdated dependencies #7019

Merged

serhalp added 14 commits February 4, 2025 10:30

fix(deps): upgrade 19 outdated dependencies

e94ccf4

fix(deps): pin inquirer to earlier patch

8da2278

There's some sort of undocumented breaking visual change that's messing with snapshot tests.

chore(deps): remove 2 unnecessary dev deps

055a7b0

fix: pin inquirer modules again

9986480

It looks like there's some sort of change in inquirer-autocomplete-prompt and it's a can of worms to troubleshoot. This in turn prevents upgrading inquirer past v8.

fix(deps): bump more dependencies

2eb463a

Revert "chore(deps): remove 2 unnecessary dev deps"

5e4b8fc

This reverts commit 055a7b0.

fix: fix duplicate httpProxy option setup

f681ba4

It looks like there was an `httpProxy` option and an `http-proxy` option but these got accidentally(?) squashed into a duplicated `httpProxy` option in https://github.com/netlify/cli/pull/5816/files#diff-6708246L106-L140.

fix: use a valid short flag for blobs:get output

c47b142

`-o` is already used in the base command for `--offline`, so this was being quietly ignored This can't be considered a breaking change as it has never worked. (I just tried it to be sure.) See tj/commander.js#2055.

fix: avoid redefining --json option in commands

899ef2a

See tj/commander.js#2055.

fix: fix duplicate -o option for deploy command

e4148b3

It's already used in the BaseCommand for `--offline`. This is not a breaking change, because this never worked as is. Same issue as in 9280c55.

fix: fix duplicate -a option in deploy commands

32a244e

It's already defined in the BaseCommand for `--offline`.

fix: fix still more --json option overrides

875edc6

fix: remove duplicate dev command short options

5a3a6ad

fix: fix env:import options

70cb303

- `-r` was already used globally so this was being ignored - the camelCase version was using the same short option as the kebab-case, which isn't allowed

serhalp added 5 commits February 4, 2025 17:35

fix: don't mutate the commander singleton

d6b0d23

It was redefining the options over and over and over. The latest commander throws.

ci: bump tested node.js 18 version

8a487a6

chore(deps): bump astro in docs site

33604c8

chore(deps): rebuild docs site package-lock

68d70f3

fix(deps): upgrade to commander@12

6aa83f2

serhalp force-pushed the fix/upgrade-misc-deps branch from 0d11dde to 6aa83f2 Compare February 4, 2025 22:45

serhalp changed the title ~~fix(deps): upgrade 23 outdated dependencies~~ fix(deps): upgrade commander Feb 4, 2025

serhalp changed the base branch from main to fix/upgrade-misc-deps-except-commander February 4, 2025 22:46

types(site): fix jsdoc types in docs script

ad03c5f

serhalp force-pushed the fix/upgrade-misc-deps branch from 1fb55f2 to ad03c5f Compare February 4, 2025 23:11

Base automatically changed from fix/upgrade-misc-deps-except-commander to main February 6, 2025 00:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): upgrade commander #7008

fix(deps): upgrade commander #7008

serhalp commented Jan 21, 2025 •

edited

Loading

serhalp Jan 21, 2025

serhalp Jan 21, 2025

serhalp Jan 22, 2025

serhalp Jan 21, 2025

serhalp Jan 21, 2025

serhalp Jan 21, 2025

serhalp Jan 22, 2025

github-actions bot commented Jan 23, 2025 •

edited

Loading

		.option('-o, --output <path>', 'Defines the filesystem path where the blob data should be persisted')
		.option('-O, --output <path>', 'Defines the filesystem path where the blob data should be persisted')

		.option('-o, --open', 'Open site after deploy', false)
		.option('-O, --open', 'Open site after deploy', false)

fix(deps): upgrade commander #7008

Are you sure you want to change the base?

fix(deps): upgrade commander #7008

Conversation

serhalp commented Jan 21, 2025 • edited Loading

serhalp Jan 21, 2025

Choose a reason for hiding this comment

serhalp Jan 21, 2025

Choose a reason for hiding this comment

serhalp Jan 22, 2025

Choose a reason for hiding this comment

serhalp Jan 21, 2025

Choose a reason for hiding this comment

serhalp Jan 21, 2025

Choose a reason for hiding this comment

serhalp Jan 21, 2025

Choose a reason for hiding this comment

serhalp Jan 22, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 23, 2025 • edited Loading

📊 Benchmark results

serhalp commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading