Wrapping the second and following line in a multiline description doesn't work if the line starts from space

[bk201-]

I wanted to add an indent to the second line in the description.

program
  .option('--config <path>', 'Configuration file path')
  .option(
    '-M, --message-pattern <RegExp>',
    `Message pattern to configure where JIRA ticket number will be inserted
    * Symbols '$J' 
    * Symbols '$M' `,
  );

I've expected something like this

Usage: index [options]   
                                       
Options:                          
  --config <path>                 Configuration file path
  -M, --message-pattern <RegExp>  Message pattern to configure where JIRA ticket number will be inserted
                                     * Symbols `$J` 
                                     * Symbols `$M`
  -h, --help                      display help for command         

But got:

Usage: index [options]   
                                       
Options:                          
  --config <path>                 Configuration file path
  -M, --message-pattern <RegExp>  Message pattern to configure where JIRA ticket number will be inserted
      * Symbols '$J'
      * Symbols '$M'
  -h, --help                      display help for command  

I tried to change the template literal to a string but got the same result.

program
  .option('--config <path>', 'Configuration file path')
  .option(
    '-M, --message-pattern <RegExp>',
    'Message pattern to configure where JIRA ticket number will be inserted\n' +
    '   * Symbols `$J`\n' +
    '   * Symbols `$M`',
 // ↑ three spaces
  );

But if I remove leading spaces from the second and third line, the indent will work correctly;

Usage: index [options]

Options:
  --config <path>                 Configuration file path
  -M, --message-pattern <RegExp>  Message pattern to configure where JIRA ticket number will be inserted
                                  * Symbols `$J`
                                  * Symbols `$M`
  -h, --help                      display help for command

[shadowspawn]

Thanks for the detailed examples.

This is an intended behaviour rather than a bug. The wrapping code does not wrap text that looks pre-formatted. When you put spaces on the start of the second line, the wrapping code assumes you have pre-formatted the text.

The current wrapping behaviour was introduced in #956 and #1051, and the issue they took into account with pre-formatted text was #396.

[bk201-]

Thank you for the clarification. I read #396, but couldn't figure out what it talking about.

In any case, it would be so great if you could add more details to the documentation.

[shadowspawn]

Adding mention of wrapping and "pre-formatted" descriptions to README in #1859.

[shadowspawn]

Added documentation in 10.0.1

Thanks @bk201

[bk201]

Hi @shadowspawn, probably a wrong mention.

[shadowspawn]

Oops sorry @bk201

Add one more character: thanks @bk201- for question.