[api-extractor] Markdown lists are not preserved in generated JSON.

[DylanVann]

Is this a feature or a bug?

• Feature
• Bug

I have a markdown list in a comment block, e.g.

/**
 * This api does things:
 *
 * - One
 * - Two
 * - Three
 *
 * @public
 */

I can see in the generated file temp/projectname.api.json that the newlines are stripped. Which looks like this:

 *
 * - One - Two - Three
 *

This can be reproduced in any simple project using api-extractor.

Even if I manually edit temp/projectname.api.json to include the list with line breaks api-documenter doesn't seem to parse it properly, and still outputs on one line.

What is the expected behavior?

Preserving newlines, so that markdown can be generated later.

If this is a bug, please provide the tool version, Node.js version, and OS.

• Tool: `api-extractor
• Tool Version: 7.3.4
• Node Version: v10.16.0
  • Is this a LTS version? yes
  • Have you tested on a LTS version? yes
• OS: macOS

[octogonz]

The TSDoc parser does not support Markdown lists yet. We need to fix that first, then we can update API Extractor to support it.

[DylanVann]

Related TSDoc parser issue: microsoft/tsdoc#178