@link jsdoc tags parse trailing parens as linkText

[mjbvz]

From DefinitelyTyped/DefinitelyTyped#53629

Bug Report

🔎 Search Terms

• jsdoc
• @link

🕗 Version & Regression Information

TS 4.3.2

💻 Code

For the code

function foo(){}

/**
 * {@link foo()}
 */
const bar = 2

1. Hover over bar

🙁 Actual behavior

The returned hover includes:

    "documentation": [
        {
            "text": "",
            "kind": "text"
        },
        {
            "text": "{@link ",
            "kind": "link"
        },
        {
            "text": "foo",
            "kind": "linkName",
            "target": {
                "file": "/Users/matb/projects/san/x.tsx",
                "start": {
                    "line": 1,
                    "offset": 1
                },
                "end": {
                    "line": 1,
                    "offset": 17
                }
            }
        },
        {
            "text": "()",
            "kind": "linkText"
        },
        {
            "text": "}",
            "kind": "link"
        }
    ],

Notice how the linkText is ()

🙂 Expected behavior

I'd expect this example to have no linkText as the () is part of the symbol name

Having trailing parens in a link in somewhat common in definitely typed (it occurs around 1000 times in my quick search) so we should likely support this case

[sandersn]

I'm looking at how to implement this and have a follow-up question:

I'm going to delete () from the linkText; would you prefer linkName to be foo() or stay foo?
My guess is: foo(), since that's what is in the source, and probably what the author thinks of as the symbol name.

[mjbvz]

@sandersn Yes that makes sense to me

[sandersn]

Quick analysis with my grep deduping script cuts the 1000 hits down to 55 uniques in 8 projects: post-css, selenium-webdriver, cassandra-driver, mongodb, firestore, punycode, mquery, mongoose.

I'm not sure why most of these are database-related. Maybe in the open source world everybody is reading each others' code.

46 of the 55 uses are @link in 5 projects. Because @see is a much less local fix I'm going to skip it for now.