JSDoc does not strip leading * inside markdown code block

TypeScript Version: 2.9.0-dev.20180418

Search Terms:

jsdoc
example
markdown

Code

/**
 * @example
 * ```
 * 1 + 2
 * ```
*/
export function foo() { }

Hover over foo

Bug:
The jsdoc content returned includes the leading * from the comment inside the code block:

[Trace  - 11:08:38 AM] Response received: quickinfo (13). Request took 2 ms. Success: true 
Result: {
    "kind": "function",
    "kindModifiers": "export",
    "start": {
        "line": 9,
        "offset": 17
    },
    "end": {
        "line": 9,
        "offset": 20
    },
    "displayString": "function foo(): void",
    "documentation": "",
    "tags": [
        {
            "name": "example",
            "text": "```\n * 1 + 2\n * ```"
        }
]
}

This is a regression from the current 2.8 builds

PRs welcomed.

I only noticed this change in behavior now after updating VSCode, but this definitely was still working correctly a couple of months ago. Also using standard (non-fenced / non-GFM) Markdown for code blocks still works correctly now. Maybe there was a change/replacement of the MD parser?

/**
 * This works as expected (w/o leading asterisks)
 *
 * @example
 *
 *    const foo = [...mapcat((x) => [x,x,x], [1,2,3])];
 *    // [[1,1,1], [2,2,2], [3,3,3]]
 */

I bisected this one down to either b56093f or ab8233c

feature #550 Clean up the public API file and improve a few other thi…

Handle jsdoc backticks in the parser, not scanner

Handle JSDoc backticks in the parser, not scanner (#30939)

Navigation Menu

Repository navigation

JSDoc does not strip leading * inside markdown code block #23517

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

JSDoc does not strip leading * inside markdown code block #23517

Description

Activity

mhegazy commented on Apr 18, 2018

postspectacular commented on Aug 2, 2018

JoelEinbinder commented on Jan 11, 2019

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions