commander 14.0.3 → 15.0.0-0

package/Readme.md

@@ -76,7 +76,7 @@ The two most used option types are a boolean option, and an option which takes i
 Example file: [split.js](./examples/split.js)
 
 ```js
-const { program } = require('commander');
+import { program } from 'commander';
 
 program
   .option('--first')
@@ -91,10 +91,10 @@ console.log(program.args[0].split(options.separator, limit));
 ```
 
 ```console
-$ node split.js -s / --fits a/b/c
+$ node split.js -s - --fits a-b-c
 error: unknown option '--fits'
 (Did you mean --first?)
-$ node split.js -s / --first a/b/c
+$ node split.js -s - --first a-b-c
 [ 'a' ]
 ```
 
@@ -103,7 +103,7 @@ Here is a more complete program using a subcommand and with descriptions for the
 Example file: [string-util.js](./examples/string-util.js)
 
 ```js
-const { Command } = require('commander');
+import { Command } from 'commander';
 const program = new Command();
 
 program
@@ -138,7 +138,7 @@ Options:
   -s, --separator <char>  separator character (default: ",")
   -h, --help              display help for command
 
-$ node string-util.js split --separator=/ a/b/c
+$ node string-util.js split --separator=- a-b-c
 [ 'a', 'b', 'c' ]
 ```
 
@@ -147,11 +147,10 @@ More samples can be found in the [examples](https://github.com/tj/commander.js/t
 ## Declaring _program_ variable
 
 Commander exports a global object which is convenient for quick programs.
-This is used in the examples in this README for brevity.
+This is used in some examples in this README for brevity.
 
 ```js
-// CommonJS (.cjs)
-const { program } = require('commander');
+import { program } from 'commander';
 ```
 
 For larger programs which may use commander in multiple ways, including unit testing, it is better to create a local `Command` object to use.
@@ -276,10 +275,7 @@ cheese: stilton
 ### Other option types, negatable boolean and boolean|value
 
 You can define a boolean option long name with a leading `no-` to set the option value to `false` when used.
-Defined alone, this also makes the option `true` by default.
-
-If you define `--foo` first, adding `--no-foo` does not change the default value from what it would
-otherwise be.
+Defined alone without a matching positive option, this also makes the option `true` by default.
 
 Example file: [options-negatable.js](./examples/options-negatable.js)
 
@@ -558,7 +554,7 @@ Configuration options can be passed with the call to `.command()` and `.addComma
 remove the command from the generated help output. Specifying `isDefault: true` will run the subcommand if no other
 subcommand is specified. (Example file: [defaultCommand.js](./examples/defaultCommand.js).)
 
-You can add alternative names for a command with `.alias()`. (Example file: [alias.js](./examples/alias.js).)
+You can add alternative names for a command with `.alias()`. (Example file: [alias.cjs](./examples/alias.cjs).)
 
 `.command()` automatically copies the inherited settings from the parent command to the newly created subcommand. This is only done during creation; any later setting changes to the parent are not inherited.
 
@@ -1060,7 +1056,7 @@ node -r ts-node/register pm.ts
 This factory function creates a new command. It is exported and may be used instead of using `new`, like:
 
 ```js
-const { createCommand } = require('commander');
+import { createCommand } from 'commander';
 const program = createCommand();
 ```
 
@@ -1163,7 +1159,7 @@ There is more information available about:
 
 ## Support
 
-The current version of Commander is fully supported on Long Term Support versions of Node.js, and requires at least v20.
+The current version of Commander is fully supported on Long Term Support versions of Node.js, and requires at least v22.12.0.
 
 Older major versions of Commander receive security updates for 12 months. For more see: [Release Policy](./docs/release-policy.md).
 

package/index.js

@@ -1,24 +1,21 @@
-const { Argument } = require('./lib/argument.js');
-const { Command } = require('./lib/command.js');
-const { CommanderError, InvalidArgumentError } = require('./lib/error.js');
-const { Help } = require('./lib/help.js');
-const { Option } = require('./lib/option.js');
+import { Argument } from './lib/argument.js';
+import { Command } from './lib/command.js';
+import { CommanderError, InvalidArgumentError } from './lib/error.js';
+import { Help } from './lib/help.js';
+import { Option } from './lib/option.js';
 
-exports.program = new Command();
+export const program = new Command();
 
-exports.createCommand = (name) => new Command(name);
-exports.createOption = (flags, description) => new Option(flags, description);
-exports.createArgument = (name, description) => new Argument(name, description);
+export const createCommand = (name) => new Command(name);
+export const createOption = (flags, description) =>
+  new Option(flags, description);
+export const createArgument = (name, description) =>
+  new Argument(name, description);
 
 /**
  * Expose classes
  */
 
-exports.Command = Command;
-exports.Option = Option;
-exports.Argument = Argument;
-exports.Help = Help;
-
-exports.CommanderError = CommanderError;
-exports.InvalidArgumentError = InvalidArgumentError;
-exports.InvalidOptionArgumentError = InvalidArgumentError; // Deprecated
+export { Command, Option, Argument, Help };
+export { CommanderError, InvalidArgumentError };
+export { InvalidArgumentError as InvalidOptionArgumentError }; // Deprecated

package/lib/argument.js

@@ -1,6 +1,6 @@
-const { InvalidArgumentError } = require('./error.js');
+import { InvalidArgumentError } from './error.js';
 
-class Argument {
+export class Argument {
   /**
    * Initialize a new command argument with the given name and description.
    * The default is that the argument is required, and you can explicitly
@@ -140,11 +140,8 @@ class Argument {
  * @private
  */
 
-function humanReadableArgName(arg) {
+export function humanReadableArgName(arg) {
   const nameOutput = arg.name() + (arg.variadic === true ? '...' : '');
 
   return arg.required ? '<' + nameOutput + '>' : '[' + nameOutput + ']';
 }
-
-exports.Argument = Argument;
-exports.humanReadableArgName = humanReadableArgName;

package/lib/command.js

@@ -1,16 +1,16 @@
-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');
+import { EventEmitter } from 'node:events';
+import childProcess from 'node:child_process';
+import path from 'node:path';
+import fs from 'node:fs';
+import process from 'node:process';
 
-const { Argument, humanReadableArgName } = require('./argument.js');
-const { CommanderError } = require('./error.js');
-const { Help, stripColor } = require('./help.js');
-const { Option, DualOptions } = require('./option.js');
-const { suggestSimilar } = require('./suggestSimilar');
+import { Argument, humanReadableArgName } from './argument.js';
+import { CommanderError } from './error.js';
+import { Help, stripColor } from './help.js';
+import { Option, DualOptions } from './option.js';
+import { suggestSimilar } from './suggestSimilar.js';
 
-class Command extends EventEmitter {
+export class Command extends EventEmitter {
   /**
    * Initialize a new `Command`.
    *
@@ -674,17 +674,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
     const name = option.attributeName();
 
     // store default value
-    if (option.negate) {
-      // --no-foo is special and defaults foo to true, unless a --foo option is already defined
-      const positiveLongFlag = option.long.replace(/^--no-/, '--');
-      if (!this._findOption(positiveLongFlag)) {
-        this.setOptionValueWithSource(
-          name,
-          option.defaultValue === undefined ? true : option.defaultValue,
-          'default',
-        );
-      }
-    } else if (option.defaultValue !== undefined) {
+    if (option.defaultValue !== undefined) {
       this.setOptionValueWithSource(name, option.defaultValue, 'default');
     }
 
@@ -1125,7 +1115,29 @@ Expecting one of '${allowedValues.join("', '")}'`);
   }
 
   _prepareForParse() {
+    // Save the state the first time, then restore the state before each subsequent parse.
     if (this._savedState === null) {
+      // Do the special default of lone negated option to true, now that we have all the options.
+      // Filter for negated options that have not been processed already.
+      this.options
+        .filter(
+          (option) =>
+            option.negate &&
+            option.defaultValue === undefined &&
+            this.getOptionValue(option.attributeName()) === undefined,
+        )
+        .forEach((option) => {
+          // check for lone negated option: --no-foo without a --foo option
+          const positiveLongFlag = option.long.replace(/^--no-/, '--');
+          if (!this._findOption(positiveLongFlag)) {
+            this.setOptionValueWithSource(
+              option.attributeName(),
+              true,
+              'default',
+            );
+          }
+        });
+
       this.saveStateBeforeParse();
     } else {
       this.restoreStateBeforeParse();
@@ -2148,8 +2160,10 @@ Expecting one of '${allowedValues.join("', '")}'`);
 
     const expected = this.registeredArguments.length;
     const s = expected === 1 ? '' : 's';
+    const received = receivedArgs.length;
     const forSubcommand = this.parent ? ` for '${this.name()}'` : '';
-    const message = `error: too many arguments${forSubcommand}. Expected ${expected} argument${s} but got ${receivedArgs.length}.`;
+    const details = receivedArgs.join(', ');
+    const message = `error: too many arguments${forSubcommand}. Expected ${expected} argument${s} but got ${received}: ${details}.`;
     this.error(message, { code: 'commander.excessArguments' });
   }
 
@@ -2405,12 +2419,12 @@ Expecting one of '${allowedValues.join("', '")}'`);
 
   /**
    * Set the name of the command from script filename, such as process.argv[1],
-   * or require.main.filename, or __filename.
+   * or import.meta.filename.
    *
    * (Used internally and public although not documented in README.)
    *
    * @example
-   * program.nameFromFilename(require.main.filename);
+   * program.nameFromFilename(import.meta.filename);
    *
    * @param {string} filename
    * @return {Command}
@@ -2426,7 +2440,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
    * Get or set the directory for searching for executable subcommands of this command.
    *
    * @example
-   * program.executableDir(__dirname);
+   * program.executableDir(import.meta.dirname);
    * // or
    * program.executableDir('subcommands');
    *
@@ -2746,10 +2760,12 @@ function incrementNodeInspectorPort(args) {
 }
 
 /**
+ * Exported for using from tests, not otherwise used outside this file.
+ *
  * @returns {boolean | undefined}
  * @package
  */
-function useColor() {
+export function useColor() {
   // Test for common conventions.
   // NB: the observed behaviour is in combination with how author adds color! For example:
   //   - we do not test NODE_DISABLE_COLORS, but util:styletext does
@@ -2772,6 +2788,3 @@ function useColor() {
     return true;
   return undefined;
 }
-
-exports.Command = Command;
-exports.useColor = useColor; // exporting for tests

package/lib/error.js

@@ -1,7 +1,7 @@
 /**
  * CommanderError class
  */
-class CommanderError extends Error {
+export class CommanderError extends Error {
   /**
    * Constructs the CommanderError class
    * @param {number} exitCode suggested exit code which could be used with process.exit
@@ -22,7 +22,7 @@ class CommanderError extends Error {
 /**
  * InvalidArgumentError class
  */
-class InvalidArgumentError extends CommanderError {
+export class InvalidArgumentError extends CommanderError {
   /**
    * Constructs the InvalidArgumentError class
    * @param {string} [message] explanation of why argument is invalid
@@ -34,6 +34,3 @@ class InvalidArgumentError extends CommanderError {
     this.name = this.constructor.name;
   }
 }
-
-exports.CommanderError = CommanderError;
-exports.InvalidArgumentError = InvalidArgumentError;

package/lib/help.js

@@ -1,4 +1,4 @@
-const { humanReadableArgName } = require('./argument.js');
+import { humanReadableArgName } from './argument.js';
 
 /**
  * TypeScript import types for JSDoc, used by Visual Studio Code IntelliSense and `npm run typescript-checkJS`
@@ -9,7 +9,7 @@ const { humanReadableArgName } = require('./argument.js');
  */
 
 // Although this is a class, methods are static in style to allow override using subclass or just functions.
-class Help {
+export class Help {
   constructor() {
     this.helpWidth = undefined;
     this.minWidthToWrap = 40;
@@ -737,11 +737,8 @@ class Help {
  * @package
  */
 
-function stripColor(str) {
+export function stripColor(str) {
   // eslint-disable-next-line no-control-regex
   const sgrPattern = /\x1b\[\d*(;\d*)*m/g;
   return str.replace(sgrPattern, '');
 }
-
-exports.Help = Help;
-exports.stripColor = stripColor;

package/lib/option.js

@@ -1,6 +1,6 @@
-const { InvalidArgumentError } = require('./error.js');
+import { InvalidArgumentError } from './error.js';
 
-class Option {
+export class Option {
   /**
    * Initialize a new `Option` with the given `flags` and `description`.
    *
@@ -265,7 +265,7 @@ class Option {
  * use cases, but is tricky for others where we want separate behaviours despite
  * the single shared option value.
  */
-class DualOptions {
+export class DualOptions {
   /**
    * @param {Option[]} options
    */
@@ -375,6 +375,3 @@ function splitOptionFlags(flags) {
 
   return { shortFlag, longFlag };
 }
-
-exports.Option = Option;
-exports.DualOptions = DualOptions;

package/lib/suggestSimilar.js

@@ -53,7 +53,7 @@ function editDistance(a, b) {
  * @returns {string}
  */
 
-function suggestSimilar(word, candidates) {
+export function suggestSimilar(word, candidates) {
   if (!candidates || candidates.length === 0) return '';
   // remove possible duplicates
   candidates = Array.from(new Set(candidates));
@@ -97,5 +97,3 @@ function suggestSimilar(word, candidates) {
   }
   return '';
 }
-
-exports.suggestSimilar = suggestSimilar;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commander",
-  "version": "14.0.3",
+  "version": "15.0.0-0",
   "description": "the complete solution for node.js command-line programs",
   "keywords": [
     "commander",
@@ -28,55 +28,37 @@
     "fix": "npm run fix:lint && npm run fix:format",
     "fix:format": "prettier --write .",
     "fix:lint": "eslint --fix .",
-    "test": "jest && npm run check:type:ts",
-    "test-all": "jest && npm run test-esm && npm run check",
-    "test-esm": "node ./tests/esm-imports-test.mjs"
+    "test": "node --test && npm run check:type:ts",
+    "test-all": "node --test && npm run check"
   },
   "files": [
     "index.js",
     "lib/*.js",
-    "esm.mjs",
     "typings/index.d.ts",
-    "typings/esm.d.mts",
     "package-support.json"
   ],
-  "type": "commonjs",
+  "type": "module",
   "main": "./index.js",
   "exports": {
     ".": {
-      "require": {
-        "types": "./typings/index.d.ts",
-        "default": "./index.js"
-      },
-      "import": {
-        "types": "./typings/esm.d.mts",
-        "default": "./esm.mjs"
-      },
+      "types": "./typings/index.d.ts",
       "default": "./index.js"
-    },
-    "./esm.mjs": {
-      "types": "./typings/esm.d.mts",
-      "import": "./esm.mjs"
     }
   },
   "devDependencies": {
     "@eslint/js": "^9.4.0",
-    "@types/jest": "^30.0.0",
     "@types/node": "^22.7.4",
     "eslint": "^9.17.0",
     "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-jest": "^29.0.1",
     "globals": "^16.0.0",
-    "jest": "^30.0.3",
     "prettier": "^3.2.5",
-    "ts-jest": "^29.0.3",
-    "tsd": "^0.33.0",
+    "tsd": "^0.31.0",
     "typescript": "^5.0.4",
     "typescript-eslint": "^8.12.2"
   },
   "types": "typings/index.d.ts",
   "engines": {
-    "node": ">=20"
+    "node": ">=22.12.0"
   },
   "support": true
 }

package/typings/index.d.ts

@@ -958,13 +958,13 @@ export class Command {
 
   /**
    * Set the name of the command from script filename, such as process.argv[1],
-   * or require.main.filename, or __filename.
+   * or import.meta.filename.
    *
    * (Used internally and public although not documented in README.)
    *
    * @example
    * ```ts
-   * program.nameFromFilename(require.main.filename);
+   * program.nameFromFilename(import.meta.filename);
    * ```
    *
    * @returns `this` command for chaining
@@ -976,7 +976,7 @@ export class Command {
    *
    * @example
    * ```ts
-   * program.executableDir(__dirname);
+   * program.executableDir(import.meta.dirname);
    * // or
    * program.executableDir('subcommands');
    * ```

package/esm.mjs

@@ -1,16 +0,0 @@
-import commander from './index.js';
-
-// wrapper to provide named exports for ESM.
-export const {
-  program,
-  createCommand,
-  createArgument,
-  createOption,
-  CommanderError,
-  InvalidArgumentError,
-  InvalidOptionArgumentError, // deprecated old name
-  Command,
-  Argument,
-  Option,
-  Help,
-} = commander;

package/typings/esm.d.mts

@@ -1,3 +0,0 @@
-// Just reexport the types from cjs
-// This is a bit indirect. There is not an index.js, but TypeScript will look for index.d.ts for types.
-export * from './index.js';