Skip to content

JSDoc # link resolution behavior broke in TS 7Β #65507

Open

Description

πŸ”Ž Search Terms

jsdoc hash link, jsdoc link resolution

πŸ•— Version & Regression Information

  • This changed between versions 6.0.3 and 7.1

⏯ Playground Link

https://www.typescriptlang.org/play/v2/#code/v2/N4IghgxgLglgbgUwGIwDYJALhAegO4D2ATgNYDOADpAjmURDjAHYAmCAHgHRRkgA0IAGZoEvTKHzFyVCDR4QCTYQHNOAKzKKsIYAB0mAAgO6QCgLYURRAPIVYisicwG9ho8ZBmCLAK7onHkzeCEwcUCZ8+u4eUGBEygjhWB6ioexJkW5GJmRQRDDQAXk+CJnRJkEAqkwQABYIECQILACSrBzNAIIQsmSOycWlUe4mHJBQtvZMYKgACkQEFAhEUACeACqrS-3Og2Ujnt5+CAAiiQ1TASaCxLIRw9kgbBCocWCXA0Ql+49kJDAUAAyMAARgBheqNIpfBDDAC++xMzBePjYAQA2iZOLR6DgAFR4-EmAC6+jh+n4uEIpEo1BxDGYbC4PG0+LxUTxLgAAqhmCQDEgCAROGYEGYQcsDAAfAy5d4FcmGTnAHl8gVCgDEovFkplzDlNQQioMhP0LzAfXVBBcwxwOAMMBaBnWAGUDAB2AwgghQWoGXlMcgGZTW+pEWFuOWwCAGbUSogGAC8BgAjAAmADMAG59Lb7W1nW6AGwGX0IAxasXx-1qkOiAxhiNGOOS5MAFgArEWc0w4SAESAyAh0NAYFpxCAKAQyDApmCCKgfGYmFgM2mBFOZ1NgaEAHJL+NYIsCIcjqYu2IreeL5er9eD4cXMdMC9xKA7hD7nVEI8DxBEGdxzTOEgA

πŸ’» Code

/**
 * {@link Foo.member | static}
 * {@link Foo#member | instance}
 */
class Foo {
  // iI TS 7 both links go here
  static member = 123;

  // In TS 6 the #member link goes here
  member = 456;
}

πŸ™ Actual behavior

TypeScript 7 link

In #61433 Ryan confirms that # for instance properties is intended to be supported.

πŸ™‚ Expected behavior

Like TS 6.0.3, TypeScript should resolve Foo.member to the static member, and Foo#member to the instance member.

Additional information about the issue

Discovered while porting TypeDoc to the 7.1 API. One version of the port introduced this hack to avoid the issue, https://github.com/TypeStrong/typedoc/pull/3163/changes#diff-0f4d3d4ff4d391e0086dc53858cfe9350761008b11b413228e30cb3433228488R359-R362

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    BugA bug in TypeScriptDomain: JSDocRelates to JSDoc parsing and type generation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions