v19.0.0

3ff290d (Update pinejs-client-core to 8.x, 2024-09-13)

v18.2.10

5ef877d (Avoid deprecated usage of pinejs-client, 2024-09-13)

v18.2.9

be8420b (Use updated pinejs-client prepare syntax, 2024-09-13)

v18.2.8

90241b7 (Update dependencies, 2024-09-13)

v18.2.7

5f68e9c (Update dependencies, 2024-09-12)

v18.2.6

b9b80e9 (Fix linting issues with latest dependencies, 2024-09-10)
a961071 (Update TypeScript to 5.6.2, 2024-09-10)

v18.2.5

Update dependency commander to v12

Notable changes

• .addHelpOption() as another way of configuring built-in help option ([#​2006])
• .helpCommand() for configuring built-in help command ([#​2087])
• Breaking: use non-zero exit code when spawned executable subcommand terminates due to a signal ([#​2023])
• Breaking: check passThroughOptions constraints when using .addCommand and throw if parent command does not have .enablePositionalOptions() enabled ([#​1937])
• Breaking: Commander 12 requires Node.js v18 or higher ([#​2027])
• Breaking: throw an error if add an option with a flag which is already in use ([#​2055])
• Breaking: throw an error if add a command with name or alias which is already in use ([#​2059])
• Breaking: throw error when calling .storeOptionsAsProperties() after setting an option value ([#​1928])
• replace non-standard JSDoc of @api private with documented @private ([#​1949])
• .addHelpCommand() now takes a Command (passing string or boolean still works as before but deprecated) ([#​2087])
• refactor internal implementation of built-in help option ([#​2006])
• refactor internal implementation of built-in help command ([#​2087])
• .addHelpCommand() passing string or boolean (use .helpCommand() or pass a Command) ([#​2087])
• Breaking: removed default export of a global Command instance from CommonJS (use the named program export instead) ([#​2017])
• adding an option which uses the same flag as a previous option
• adding a command which uses the same name or alias as a previous command

tj/commander.js (commander)

v12.1.0

Compare Source

Added

v12.0.0

Compare Source

Added

• .addHelpOption() as another way of configuring built-in help option ([#​2006])
• .helpCommand() for configuring built-in help command ([#​2087])

Fixed

• Breaking: use non-zero exit code when spawned executable subcommand terminates due to a signal ([#​2023])
• Breaking: check passThroughOptions constraints when using .addCommand and throw if parent command does not have .enablePositionalOptions() enabled ([#​1937])

Changed

• Breaking: Commander 12 requires Node.js v18 or higher ([#​2027])
• Breaking: throw an error if add an option with a flag which is already in use ([#​2055])
• Breaking: throw an error if add a command with name or alias which is already in use ([#​2059])
• Breaking: throw error when calling .storeOptionsAsProperties() after setting an option value ([#​1928])
• replace non-standard JSDoc of @api private with documented @private ([#​1949])
• .addHelpCommand() now takes a Command (passing string or boolean still works as before but deprecated) ([#​2087])
• refactor internal implementation of built-in help option ([#​2006])
• refactor internal implementation of built-in help command ([#​2087])

Deprecated

• .addHelpCommand() passing string or boolean (use .helpCommand() or pass a Command) ([#​2087])

Removed

• Breaking: removed default export of a global Command instance from CommonJS (use the named program export instead) ([#​2017])

Migration Tips

global program

If you are using the deprecated default import of the global Command object, you need to switch to using a named import (or create a new Command).

// const program = require('commander');
const { program } = require('commander');

option and command clashes

A couple of configuration problems now throw an error, which will pick up issues in existing programs:

• adding an option which uses the same flag as a previous option
• adding a command which uses the same name or alias as a previous command

List of commits

eb10dbd (Update dependency commander to v12, 2024-09-09)

v18.2.4

0ae61c0 (Tests: update nodejs to 20.x matching the minimum supported version, 2024-09-09)

v18.2.3

7c5abc0 (Update dependencies, 2024-09-06)

v18.2.2

5d40b0c (Remove unused dev dependencies, 2024-09-05)