Quick info uses JSDoc for inherited instance property with static property of same name

[HolgerJeromin]

Bug Report

🔎 Search Terms

static class instance intellisense

🕗 Version & Regression Information

Tested TS 3.3 till nightly

• This is the behavior in every version I tried, and I reviewed the FAQ

⏯ Playground Link and 💻 Code

class foo {
    constructor() { }
    /** instance bar */
    readonly bar = 'instance foo';
}
class foo2 extends foo {
    static readonly bar = 'class foo2';   // <- look at tooltip for 'bar' here
}

Workbench Repro

A bit larger example:

class foo{
    constructor() {
    }
    /** instance bar */
    readonly bar = 'instance foo';  //    <- tooltip here for 'bar' is correct
    /** class bar */
    static readonly bar: string = 'class foo'; //   <- tooltip here for 'bar' is correct
}
class foo2 extends foo{
    static readonly bar = 'class foo2'; // <- look at tooltip for 'bar' here
}

Workbench Repro

🙁 Actual behavior

Hover with the mouse over the static property of the inherited class. Is shows the jsdoc / tsdoc information from the instance property.

🙂 Expected behavior

In the first example the tooltip should show nothing. In the second example I should see class bar.

[eliasm307]

@sandersn Hello, I would like to give this a go but it's my first time contributing to this repo, are you able to direct me to a good starting point, if it's still available to be worked on?

[sandersn]

I would start in src/services/services.ts:getQuickInfoAtPosition. Looking over the code there, it looks like the documentation property comes from Symbol.getDocumentationComment and the tags property comes from Symbol.getJsDocTags. Both of those quickly delegate to code in src/services/jsDoc.ts.

Edit: Read CONTRIBUTING.md for instructions on building and running tests.

[eliasm307]

@sandersn ok thanks for the tips, I'll look into this over the weekend

[eliasm307]

@sandersn I'm still figuring out the code base however I've got a question regarding testing. So from what I understand it is like snapshot testing where in this case "baselines" are defined for different code examples in different formats to describe the expected symbols, types etc for each line of example code.

So following from this I have tried to create a failing test to highlight the points in this issue and I get the following symbol baseline:

=== tests/cases/conformance/jsdoc/jsDocClassStaticProperty.ts ===
// Bug 45907
class Foo1 {
>Foo1 : Symbol(Foo1, Decl(jsDocClassStaticProperty.ts, 0, 0))

  /** instance bar */
  readonly bar1 = 'instance Foo1';
>bar1 : Symbol(Foo1.bar1, Decl(jsDocClassStaticProperty.ts, 1, 12))

  constructor() { }
}

class Foo2 extends Foo1 {
>Foo2 : Symbol(Foo2, Decl(jsDocClassStaticProperty.ts, 6, 1))
>Foo1 : Symbol(Foo1, Decl(jsDocClassStaticProperty.ts, 0, 0))

  static readonly bar1 = 'class Foo2';
>bar1 : Symbol(Foo2.bar1, Decl(jsDocClassStaticProperty.ts, 8, 25))
}

class Foo3 {
>Foo3 : Symbol(Foo3, Decl(jsDocClassStaticProperty.ts, 10, 1))

  /** class bar */
  static readonly bar2: string = 'class Foo3';
>bar2 : Symbol(Foo3.bar2, Decl(jsDocClassStaticProperty.ts, 12, 12))

  /** instance bar */
  readonly bar2 = 'instance Foo3';
>bar2 : Symbol(Foo3.bar2, Decl(jsDocClassStaticProperty.ts, 14, 46))

  constructor() {
  }
}

class Foo4 extends Foo3 {
>Foo4 : Symbol(Foo4, Decl(jsDocClassStaticProperty.ts, 21, 1))
>Foo3 : Symbol(Foo3, Decl(jsDocClassStaticProperty.ts, 10, 1))

  static readonly bar2 = 'class Foo4';
>bar2 : Symbol(Foo4.bar2, Decl(jsDocClassStaticProperty.ts, 23, 25))
}

I'm assuming lines like >bar1 : Symbol(Foo1.bar1, Decl(jsDocClassStaticProperty.ts, 1, 12)) are to represent declaring a unique code symbol based on the item "Foo1.bar1" and context information from a specific file where the symbol is defined, in this case
"jsDocClassStaticProperty.ts" and the line number and character number on that line the symbol starts from. Then the same symbol can be represented in other places using the same file, line number, and character number information.

If the above is accurate, then I'm not sure how to test this issue as it seems to declare the relevant symbols as unique but the issue is with the content of the documentation which isnt shown in the tests explicitly? Please let me know if I have misunderstood anything.

[eliasm307]

I've found the fourslash tests which seem to be more appropriate, let me know if this is the right place to be looking

[sandersn]

Yes, fourslash is the correct place. Let me know if you need additional pointers; you probably want to write an example program and then call verify.baselineQuickInfo()

[eliasm307]

Oh, hadn't noticed someone was already working on it, atleast it's been resolved :D

[HolgerJeromin]

works in playground.
thanks @a-tarasyuk