Add a helper to apply shared command configuration

[goodov]

Please consider adding a helper like this to batch-configure args/options/etc. across multiple unrelated commands.

declare module '@commander-js/extra-typings' {
  interface Command<
    Args extends any[] = [],
    Opts extends OptionValues = {},
    GlobalOpts extends OptionValues = {},
  > {
    apply<R>(fn: (command: this) => R): R
  }
}

// Passes the command to a function that configures it, so reusable configurators
// can be applied without breaking the call chain.
Command.prototype.apply = function <R>(
  this: Command,
  fn: (command: Command) => R,
): R {
  return fn(this)
}

This can be used like so:

export function addBuildDirectoryOption<
  Args extends any[],
  Opts extends OptionValues,
  GlobalOpts extends OptionValues,
>(command: Command<Args, Opts, GlobalOpts>) {
  return command
    .option('-C <build_dir>', 'build directory, relative to out/ or absolute')
    .hook('preAction', (thisCommand) => {
      config.applyBuildDirectoryOption(thisCommand.opts())
    })
}
...
program
  .description('hello')
  .apply(addBuildDirectoryOption)
  .apply(addOtherOptions)
  .apply(addAnotherOptions)
  .action(...)

another_program_in_other_file
  .description('hello2')
  .apply(addOtherOptions)
  .action(...)

[shadowspawn]

I can see some attraction in ergonomics for chaining, and for type inference when using @commander-js/extra-typings.

Not sure that tidy and compelling enough to add, but will keep this open to gather interest.

[goodov]

I can see some attraction in ergonomics for chaining, and for type inference when using @commander-js/extra-typings.

Not sure that tidy and compelling enough to add, but will keep this open to gather interest.

I was looking at open issues and I believe this one has the same idea #2505 where another person proposed a .register() call in their PoC https://github.com/danielpza/commander-register which is effectively equal to .apply() that I have here lol.

This adds a missing extensibility and scalability piece for commands and costs practically nothing. It's not strictly about "plugins/extensions", but more about an external mechanism to configure a command. Whatever users might want to add into ALL commands - with this they can do that very easy.

[HyphensPeciwse33]

import { Command } from 'commander';
const program = new Command();

program
  .name('file-manager')
  .description('A modified CLI utility for processing files')
  .version('2.0.0');

// Modified command structure with custom error validation
program.command('modify')
  .description('Modify file content by replacing target text')
  .argument('<file>', 'path to the target file')
  .requiredOption('-t, --target <string>', 'text string to find and replace')
  .option('-r, --replacement <string>', 'new text to insert instead', '')
  .option('-v, --verbose', 'display detailed execution logs')
  .action((file, options) => {
    if (options.verbose) {
      console.log(`Reading file from path: ${file}`);
      console.log(`Replacing matches of "${options.target}" with "${options.replacement}"`);
    }
    // Execution logic goes here
    console.log(`Successfully modified: ${file}`);
  });

program.parse();

[HyphensPeciwse33]

import { Command } from 'commander';
const program = new Command();

program
.name('file-manager')
.description('A modified CLI utility for processing files')
.version('2.0.0');

// Modified command structure with custom error validation
program.command('modify')
.description('Modify file content by replacing target text')
.argument('', 'path to the target file')
.requiredOption('-t, --target ', 'text string to find and replace')
.option('-r, --replacement ', 'new text to insert instead', '')
.option('-v, --verbose', 'display detailed execution logs')
.action((file, options) => {
if (options.verbose) {
console.log(Reading file from path: ${file});
console.log(Replacing matches of "${options.target}" with "${options.replacement}");
}
// Execution logic goes here
console.log(Successfully modified: ${file});
});

program.parse();

Wait ```js
import { Command } from 'commander';
import fs from 'fs';

const program = new Command();

program
.name('file-manager')
.description('A modified CLI utility for processing files')
.version('2.0.0');

// Modified command structure with custom error validation
program.command('modify')
.description('Modify file content by replacing target text')
.argument('', 'path to the target file')
.requiredOption('-t, --target ', 'text string to find and replace')
.option('-r, --replacement ', 'new text to insert instead', '')
.option('-v, --verbose', 'display detailed execution logs')
.option('-g, --global', 'replace all occurrences')
.action((file, options) => {
try {
// Validate file exists
if (!fs.existsSync(file)) {
console.error(Error: File not found: ${file});
process.exit(1);
}

  if (options.verbose) {
    console.log(`Reading file from path: ${file}`);
    console.log(`Replacing matches of "${options.target}" with "${options.replacement}"`);
  }

  // Read file content
  const content = fs.readFileSync(file, 'utf-8');

  // Perform replacement
  const modified = options.global
    ? content.replaceAll(options.target, options.replacement)
    : content.replace(options.target, options.replacement);

  // Write modified content back
  fs.writeFileSync(file, modified, 'utf-8');

  if (options.verbose) {
    console.log(`File content updated successfully`);
  }
  console.log(`Successfully modified: ${file}`);
} catch (error) {
  console.error(`Error: ${error.message}`);
  process.exit(1);
}

});

program.parse();

[HyphensPeciwse33]

What is happening to the code

[HyphensPeciwse33]

let me try again

[HyphensPeciwse33]

import { Command } from 'commander';
import fs from 'fs';

const program = new Command();

program
  .name('file-manager')
  .description('A modified CLI utility for processing files')
  .version('2.0.0');

// Modified command structure with custom error validation
program.command('modify')
  .description('Modify file content by replacing target text')
  .argument('<file>', 'path to the target file')
  .requiredOption('-t, --target <string>', 'text string to find and replace')
  .option('-r, --replacement <string>', 'new text to insert instead', '')
  .option('-v, --verbose', 'display detailed execution logs')
  .option('-g, --global', 'replace all occurrences')
  .action((file, options) => {
    try {
      // Validate file exists
      if (!fs.existsSync(file)) {
        console.error(`Error: File not found: ${file}`);
        process.exit(1);
      }

      if (options.verbose) {
        console.log(`Reading file from path: ${file}`);
        console.log(`Replacing matches of "${options.target}" with "${options.replacement}"`);
      }

      // Read file content
      const content = fs.readFileSync(file, 'utf-8');

      // Perform replacement
      const modified = options.global
        ? content.replaceAll(options.target, options.replacement)
        : content.replace(options.target, options.replacement);

      // Write modified content back
      fs.writeFileSync(file, modified, 'utf-8');

      if (options.verbose) {
        console.log(`File content updated successfully`);
      }
      console.log(`Successfully modified: ${file}`);
    } catch (error) {
      console.error(`Error: ${error.message}`);
      process.exit(1);
    }
  });

program.parse();