Headers are hard-coded in Help.formatHelp()

[edukisto]

Is there a cleaner way to internationalize the headers, which are hard-coded in Help.formatHelp(), i. e. Arguments, Commands, Options, Usage?

import process from 'process';
import { Command, Help } from 'commander';

class MyHelp extends Help {
  formatHelp(cmd, helper) {
    const result = super.formatHelp(cmd, helper);
    return result.replace('Usage:', 'Verwendung:'); // Translate!
  }
}

class MyCommand extends Command {
  createHelp() {
    return Object.assign(new MyHelp(), this.configureHelp());
  }
}

const program = new MyCommand();
program.parse(process.argv);

[shadowspawn]

There is not support to internationalize strings so that approach is reasonable. You can either reimplement the routine, or modify the string it returns as you did.

You can also achieve the same thing without making a subclass using .configureHelp(), but same idea.

Related: #128 #774

[edukisto]

Command.configureHelp()? Did you mean Command.configureOutput()?

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

const program = new Command();

program.configureOutput({
  writeErr: (str) => process.stderr.write(
    str
      .replace('error:', 'ошибка:')
      // Proceed to replace other tokens from lib/command.js.
  ),

  writeOut: (str) => process.stdout.write(
    str
      .replace('Arguments:', 'Аргументы:')
      .replace('Commands:', 'Команды:')
      .replace('Options:', 'Опции:')
      .replace('Usage:', 'Использование:')
  ),
});

program.parse(process.argv);

[shadowspawn]

configureOutput works too! But be aware that the help can be displayed using writeErr too, like for no subcommand specified for program with subcommands.

I did mean configureHelp:

import * as process from 'process';
import { Command, Help } from 'commander';

const program = new Command();

program.configureHelp({
  formatHelp: (cmd, helper) => {
    const originalHelp = new Help();
    return originalHelp.formatHelp(cmd, helper)
      .replace('Arguments:', 'Аргументы:')
      .replace('Commands:', 'Команды:')
      .replace('Options:', 'Опции:')
      .replace('Usage:', 'Использование:');
  }
});

program.parse(process.argv);

[edukisto]

Ah, now I see how to use configureHelp() to override formatHelp(). This is a pretty clean way.
Thank you very much!

[shadowspawn]

Anyone following this issue is likely to be interested in #1801