Skip to content

JSDoc type reference understands require with entity name #34804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10765,11 +10765,15 @@ namespace ts {
let typeType = valueType;
if (symbol.valueDeclaration) {
const decl = getRootDeclaration(symbol.valueDeclaration);
const isRequireAlias = isVariableDeclaration(decl)
&& decl.initializer
&& isCallExpression(decl.initializer)
&& isRequireCall(decl.initializer, /*requireStringLiteralLikeArgument*/ true)
&& valueType.symbol;
let isRequireAlias = false;
if (isVariableDeclaration(decl) && decl.initializer) {
let expr = decl.initializer;
// skip past entity names, eg `require("x").a.b.c`
while (isPropertyAccessExpression(expr)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about optional chains?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those work -- I added a test. I guess they use the same AST as normal property access expressions?

expr = expr.expression;
}
isRequireAlias = isCallExpression(expr) && isRequireCall(expr, /*requireStringLiteralLikeArgument*/ true) && !!valueType.symbol;
}
if (isRequireAlias || node.kind === SyntaxKind.ImportType) {
typeType = getTypeReferenceType(node, valueType.symbol);
}
Expand Down
58 changes: 58 additions & 0 deletions tests/baselines/reference/jsdocTypeReferenceToImport.symbols
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
=== tests/cases/conformance/jsdoc/jsdocTypeReferenceToImport.js ===
// #34802

const C = require('./ex').C;
>C : Symbol(C, Decl(jsdocTypeReferenceToImport.js, 2, 5))
>require('./ex').C : Symbol(C, Decl(ex.d.ts, 0, 0))
>require : Symbol(require)
>'./ex' : Symbol("tests/cases/conformance/jsdoc/ex", Decl(ex.d.ts, 0, 0))
>C : Symbol(C, Decl(ex.d.ts, 0, 0))

const D = require('./ex')?.C;
>D : Symbol(D, Decl(jsdocTypeReferenceToImport.js, 3, 5))
>require('./ex')?.C : Symbol(C, Decl(ex.d.ts, 0, 0))
>require : Symbol(require)
>'./ex' : Symbol("tests/cases/conformance/jsdoc/ex", Decl(ex.d.ts, 0, 0))
>C : Symbol(C, Decl(ex.d.ts, 0, 0))

/** @type {C} c */
var c = new C()
>c : Symbol(c, Decl(jsdocTypeReferenceToImport.js, 5, 3))
>C : Symbol(C, Decl(jsdocTypeReferenceToImport.js, 2, 5))

c.start
>c.start : Symbol(C.start, Decl(ex.d.ts, 0, 16))
>c : Symbol(c, Decl(jsdocTypeReferenceToImport.js, 5, 3))
>start : Symbol(C.start, Decl(ex.d.ts, 0, 16))

c.end
>c.end : Symbol(C.end, Decl(ex.d.ts, 1, 17))
>c : Symbol(c, Decl(jsdocTypeReferenceToImport.js, 5, 3))
>end : Symbol(C.end, Decl(ex.d.ts, 1, 17))

/** @type {D} c */
var d = new D()
>d : Symbol(d, Decl(jsdocTypeReferenceToImport.js, 10, 3))
>D : Symbol(D, Decl(jsdocTypeReferenceToImport.js, 3, 5))

d.start
>d.start : Symbol(C.start, Decl(ex.d.ts, 0, 16))
>d : Symbol(d, Decl(jsdocTypeReferenceToImport.js, 10, 3))
>start : Symbol(C.start, Decl(ex.d.ts, 0, 16))

d.end
>d.end : Symbol(C.end, Decl(ex.d.ts, 1, 17))
>d : Symbol(d, Decl(jsdocTypeReferenceToImport.js, 10, 3))
>end : Symbol(C.end, Decl(ex.d.ts, 1, 17))

=== tests/cases/conformance/jsdoc/ex.d.ts ===
export class C {
>C : Symbol(C, Decl(ex.d.ts, 0, 0))

start: number
>start : Symbol(C.start, Decl(ex.d.ts, 0, 16))

end: number
>end : Symbol(C.end, Decl(ex.d.ts, 1, 17))
}

62 changes: 62 additions & 0 deletions tests/baselines/reference/jsdocTypeReferenceToImport.types
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
=== tests/cases/conformance/jsdoc/jsdocTypeReferenceToImport.js ===
// #34802

const C = require('./ex').C;
>C : typeof import("tests/cases/conformance/jsdoc/ex").C
>require('./ex').C : typeof import("tests/cases/conformance/jsdoc/ex").C
>require('./ex') : typeof import("tests/cases/conformance/jsdoc/ex")
>require : any
>'./ex' : "./ex"
>C : typeof import("tests/cases/conformance/jsdoc/ex").C

const D = require('./ex')?.C;
>D : typeof import("tests/cases/conformance/jsdoc/ex").C
>require('./ex')?.C : typeof import("tests/cases/conformance/jsdoc/ex").C
>require('./ex') : typeof import("tests/cases/conformance/jsdoc/ex")
>require : any
>'./ex' : "./ex"
>C : typeof import("tests/cases/conformance/jsdoc/ex").C

/** @type {C} c */
var c = new C()
>c : import("tests/cases/conformance/jsdoc/ex").C
>new C() : import("tests/cases/conformance/jsdoc/ex").C
>C : typeof import("tests/cases/conformance/jsdoc/ex").C

c.start
>c.start : number
>c : import("tests/cases/conformance/jsdoc/ex").C
>start : number

c.end
>c.end : number
>c : import("tests/cases/conformance/jsdoc/ex").C
>end : number

/** @type {D} c */
var d = new D()
>d : import("tests/cases/conformance/jsdoc/ex").C
>new D() : import("tests/cases/conformance/jsdoc/ex").C
>D : typeof import("tests/cases/conformance/jsdoc/ex").C

d.start
>d.start : number
>d : import("tests/cases/conformance/jsdoc/ex").C
>start : number

d.end
>d.end : number
>d : import("tests/cases/conformance/jsdoc/ex").C
>end : number

=== tests/cases/conformance/jsdoc/ex.d.ts ===
export class C {
>C : C

start: number
>start : number

end: number
>end : number
}

23 changes: 23 additions & 0 deletions tests/cases/conformance/jsdoc/jsdocTypeReferenceToImport.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// #34802
// @Filename: jsdocTypeReferenceToImport.js
// @noEmit: true
// @allowJs: true
// @checkJs: true

const C = require('./ex').C;
const D = require('./ex')?.C;
/** @type {C} c */
var c = new C()
c.start
c.end

/** @type {D} c */
var d = new D()
d.start
d.end

// @Filename: ex.d.ts
export class C {
start: number
end: number
}