[PR with tiny fixes] Fix help command for subcommands with an executable handler and only a short help flag. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages. #1930

Merged

abetomo merged 5 commits intotj:developfrom

aweebit:feature/fixes

Aug 19, 2023

Contributor

aweebit commented Aug 3, 2023 •

edited

Loading

Tiny fixes that don't really belong anywhere else.

ChangeLog

Changed

~~do not call preSubcommand hooks when displaying help for a subcommand with an executable handler~~
- ~~(technically breaking, but hey, are we really going to assume someone relied on this?)~~
deviating help flags specified for a subcommand with an executable handler via .helpOption() are now respected by the parent's help command (passed to the subcommand instead of the parent's help flag)

Fixed

~~.version() optional parameter type~~
subcommands with an executable handler and only a short help flag are now handled correctly by the parent's help command
stopped using undefined long help option flag in legacy code

aweebit added 2 commits

August 3, 2023 13:04


          Fix version() parameter type

e8bea4a

Borrowed from a3f0e28 that was supposed to land in the now-closed tj#1921.


          Change initial variable values in test for better error messages

e4d00db

(cherry picked from commit 87db4ba)

This was referenced Aug 3, 2023

Enforce correct option usage and support custom option flag and name extraction in helpOption() #1926

Closed

Allow dynamically updating version number and version option flags and description #1933

Closed


          Do not use undefined long help option flag in legacy code

35e9571

aweebit changed the title ~~Fix version() parameter type and change initial variable values in test for better error messages~~ (PR with tiny fixes) Fix version() parameter type. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages.

aweebit changed the title ~~(PR with tiny fixes) Fix version() parameter type. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages.~~ [PR with tiny fixes] Fix version() parameter type. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages.

This was referenced Aug 4, 2023

Use createOption() in helpOption() to support custom option flag extraction (+ various improvements) #1929

Closed

Warn about obscured help option #1931

Closed

Refactor help option and improve option parsing from parent when default command is invoked implicitly #1934

Closed

Add missing test and support help options with only the short flag in Help.visibleOptions() #1935

Closed

shadowspawn added the on hold label

aweebit mentioned this pull request

Clean up state from previous parse call when calling parse() / parseAsync() #1919

Closed

Contributor Author

aweebit commented Aug 12, 2023 •

edited

Loading

The .version() type fix has to agree with whatever decision about the future of the call with no parameters is made in #1954.

Note for myself

One. Change. Per. PR. Always. (no matter how tiny it is)

shadowspawn reviewed

View reviewed changes

lib/command.js Outdated Show resolved Hide resolved

shadowspawn reviewed

View reviewed changes

lib/command.js Outdated Show resolved Hide resolved

shadowspawn reviewed

View reviewed changes

lib/command.js Show resolved Hide resolved

shadowspawn reviewed

View reviewed changes

typings/index.d.ts Outdated Show resolved Hide resolved

shadowspawn reviewed

View reviewed changes

typings/index.test-d.ts Outdated Show resolved Hide resolved

shadowspawn removed the on hold label

shadowspawn requested changes

View reviewed changes

Collaborator

shadowspawn left a comment •

edited

Loading

Couple of good fixes for the reasonably recent possibility the help option might only have short flag.

Changes noted in separate comments.


          Revert "Fix version() parameter type"

a253ec6

This reverts commit e8bea4a.

aweebit force-pushed the feature/fixes branch from f3a45fb to a253ec6 Compare

August 12, 2023 23:12

aweebit commented

View reviewed changes

lib/command.js Outdated Show resolved Hide resolved

aweebit requested a review from shadowspawn

August 13, 2023 00:12

aweebit changed the title ~~[PR with tiny fixes] Fix version() parameter type. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages.~~ [PR with tiny fixes] Fix help command for subcommand with an executable handler. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages.

aweebit changed the title [PR with tiny fixes] Fix help command for subcommand with an executable handler. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages. [PR with tiny fixes] Fix help command for subcommands with an executable handler. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages.

shadowspawn reviewed

View reviewed changes

lib/command.js Outdated Show resolved Hide resolved


          Fix help for commands with executable handler & only a short help flag

8dd417f

aweebit force-pushed the feature/fixes branch from 23bb761 to 8dd417f Compare

August 13, 2023 01:02

Contributor Author

aweebit commented Aug 13, 2023

Sorry about the force pushes, there is just already enough clutter in other PRs due to this one, and I don't want to introduce even more.

aweebit changed the title [PR with tiny fixes] Fix help command for subcommands with an executable handler. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages. [PR with tiny fixes] Fix help command for subcommands with an executable handler and only a short help flag. Do not use undefined long help option flag in legacy code. Change initial variable values in test for better error messages.

shadowspawn approved these changes

View reviewed changes

Contributor Author

aweebit commented Aug 13, 2023

Thank you for the patience, I know this PR is a mess.

This was referenced Aug 13, 2023

Never call preSubcommand hooks on help command #1956

Closed

Add support for executable subcommands with help flags differing from those of the parent command #1957

Closed

Pull request catalog by @aweebit #1964

Closed

Fix .description(): do not set command description if undefined is provided in the first parameter #1966

Closed

abetomo approved these changes

View reviewed changes

Collaborator

abetomo left a comment

+1

abetomo merged commit c117172 into tj:develop

shadowspawn added the pending release label

shadowspawn removed the pending release label

hakuun mentioned this pull request

[Snyk] Upgrade commander from 11.0.0 to 11.1.0 hakuun/node-package-offline-downloader#2

Open

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

This was referenced Jul 5, 2024

[Snyk] Upgrade commander from 4.1.0 to 12.1.0 Morin3/platform-samples#3

Open

[Snyk] Upgrade commander from 2.20.3 to 12.1.0 Morin3/Hcc12#3

Merged

[Snyk] Upgrade commander from 11.1.0 to 12.1.0 Morin3/vuejs.de#1

Open

[Snyk] Upgrade commander from 4.1.0 to 12.1.0 Morin3/Hcc12#10

Merged

snyk-io bot mentioned this pull request

[Snyk] Upgrade commander from 4.1.0 to 12.1.0 Morin3/Hcc12#20

Open

Elenore23 mentioned this pull request

[Snyk] Upgrade commander from 11.0.0 to 11.1.0 Elenore23/zksync-cli#4

Open

Ramyromel mentioned this pull request

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

Merged

This was referenced 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

[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

This was referenced 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

[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

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

Open

jihaui mentioned this pull request

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

Open

lholmquist mentioned this pull request

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

Closed

snyk-io bot mentioned this pull request

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

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet