Skip to content
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.

Sign up for GitHub

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

Treat BigInt type references in JSDoc as intended bigints #60863

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+154 −42
Open

Treat BigInt type references in JSDoc as intended bigints #60863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16683,6 +16683,9 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
case "Number":
checkNoTypeArguments(node);
return numberType;
case "BigInt":
checkNoTypeArguments(node);
return bigintType;
case "Boolean":
checkNoTypeArguments(node);
return booleanType;
Expand Down
16 changes: 16 additions & 0 deletions tests/baselines/reference/checkJsdocTypeTag8.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
//// [tests/cases/conformance/jsdoc/checkJsdocTypeTag8.ts] ////

=== index.js ===
// https://github.com/microsoft/TypeScript/issues/57953

/**
* @param {Number|BigInt} n
*/
function isLessThanFive(n) {
>isLessThanFive : Symbol(isLessThanFive, Decl(index.js, 0, 0))
>n : Symbol(n, Decl(index.js, 5, 24))

return n < 5;
>n : Symbol(n, Decl(index.js, 5, 24))
}

23 changes: 23 additions & 0 deletions tests/baselines/reference/checkJsdocTypeTag8.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
//// [tests/cases/conformance/jsdoc/checkJsdocTypeTag8.ts] ////

=== index.js ===
// https://github.com/microsoft/TypeScript/issues/57953

/**
* @param {Number|BigInt} n
*/
function isLessThanFive(n) {
>isLessThanFive : (n: number | bigint) => boolean
> : ^ ^^^^^^^^ ^^^^^^^^^^^^^^^^^^
>n : number | bigint
> : ^^^^^^^^^^^^^^^

return n < 5;
>n < 5 : boolean
> : ^^^^^^^
>n : number | bigint
> : ^^^^^^^^^^^^^^^
>5 : 5
> : ^
}

14 changes: 14 additions & 0 deletions tests/baselines/reference/jsdocTypeTag.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ var N;
/** @type {number} */
var n;

/** @type {BigInt} */
var BI;

/** @type {bigint} */
var bi;

/** @type {Boolean} */
var B;

Expand Down Expand Up @@ -74,6 +80,8 @@ var N: number;
var n: number
var B: boolean;
var b: boolean;
var BI: bigint;
var bi: bigint;
var V :void;
var v: void;
var U: undefined;
Expand Down Expand Up @@ -101,6 +109,10 @@ var s;
var N;
/** @type {number} */
var n;
/** @type {BigInt} */
var BI;
/** @type {bigint} */
var bi;
/** @type {Boolean} */
var B;
/** @type {boolean} */
Expand Down Expand Up @@ -144,6 +156,8 @@ var N;
var n;
var B;
var b;
var BI;
var bi;
var V;
var v;
var U;
Expand Down
98 changes: 56 additions & 42 deletions tests/baselines/reference/jsdocTypeTag.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,77 +17,85 @@ var N;
var n;
>n : Symbol(n, Decl(a.js, 10, 3), Decl(b.ts, 3, 3))

/** @type {BigInt} */
var BI;
>BI : Symbol(BI, Decl(a.js, 13, 3), Decl(b.ts, 6, 3))

/** @type {bigint} */
var bi;
>bi : Symbol(bi, Decl(a.js, 16, 3), Decl(b.ts, 7, 3))

/** @type {Boolean} */
var B;
>B : Symbol(B, Decl(a.js, 13, 3), Decl(b.ts, 4, 3))
>B : Symbol(B, Decl(a.js, 19, 3), Decl(b.ts, 4, 3))

/** @type {boolean} */
var b;
>b : Symbol(b, Decl(a.js, 16, 3), Decl(b.ts, 5, 3))
>b : Symbol(b, Decl(a.js, 22, 3), Decl(b.ts, 5, 3))

/** @type {Void} */
var V;
>V : Symbol(V, Decl(a.js, 19, 3), Decl(b.ts, 6, 3))
>V : Symbol(V, Decl(a.js, 25, 3), Decl(b.ts, 8, 3))

/** @type {void} */
var v;
>v : Symbol(v, Decl(a.js, 22, 3), Decl(b.ts, 7, 3))
>v : Symbol(v, Decl(a.js, 28, 3), Decl(b.ts, 9, 3))

/** @type {Undefined} */
var U;
>U : Symbol(U, Decl(a.js, 25, 3), Decl(b.ts, 8, 3))
>U : Symbol(U, Decl(a.js, 31, 3), Decl(b.ts, 10, 3))

/** @type {undefined} */
var u;
>u : Symbol(u, Decl(a.js, 28, 3), Decl(b.ts, 9, 3))
>u : Symbol(u, Decl(a.js, 34, 3), Decl(b.ts, 11, 3))

/** @type {Null} */
var Nl;
>Nl : Symbol(Nl, Decl(a.js, 31, 3), Decl(b.ts, 10, 3))
>Nl : Symbol(Nl, Decl(a.js, 37, 3), Decl(b.ts, 12, 3))

/** @type {null} */
var nl;
>nl : Symbol(nl, Decl(a.js, 34, 3), Decl(b.ts, 11, 3))
>nl : Symbol(nl, Decl(a.js, 40, 3), Decl(b.ts, 13, 3))

/** @type {Array} */
var A;
>A : Symbol(A, Decl(a.js, 37, 3), Decl(b.ts, 12, 3))
>A : Symbol(A, Decl(a.js, 43, 3), Decl(b.ts, 14, 3))

/** @type {array} */
var a;
>a : Symbol(a, Decl(a.js, 40, 3), Decl(b.ts, 13, 3))
>a : Symbol(a, Decl(a.js, 46, 3), Decl(b.ts, 15, 3))

/** @type {Promise} */
var P;
>P : Symbol(P, Decl(a.js, 43, 3), Decl(b.ts, 14, 3))
>P : Symbol(P, Decl(a.js, 49, 3), Decl(b.ts, 16, 3))

/** @type {promise} */
var p;
>p : Symbol(p, Decl(a.js, 46, 3), Decl(b.ts, 15, 3))
>p : Symbol(p, Decl(a.js, 52, 3), Decl(b.ts, 17, 3))

/** @type {?number} */
var nullable;
>nullable : Symbol(nullable, Decl(a.js, 49, 3), Decl(b.ts, 16, 3))
>nullable : Symbol(nullable, Decl(a.js, 55, 3), Decl(b.ts, 18, 3))

/** @type {Object} */
var Obj;
>Obj : Symbol(Obj, Decl(a.js, 52, 3), Decl(b.ts, 17, 3))
>Obj : Symbol(Obj, Decl(a.js, 58, 3), Decl(b.ts, 19, 3))

/** @type {object} */
var obj;
>obj : Symbol(obj, Decl(a.js, 55, 3), Decl(b.ts, 18, 3))
>obj : Symbol(obj, Decl(a.js, 61, 3), Decl(b.ts, 20, 3))

/** @type {Function} */
var Func;
>Func : Symbol(Func, Decl(a.js, 58, 3), Decl(b.ts, 19, 3))
>Func : Symbol(Func, Decl(a.js, 64, 3), Decl(b.ts, 21, 3))

/** @type {(s: string) => number} */
var f;
>f : Symbol(f, Decl(a.js, 61, 3), Decl(b.ts, 20, 3))
>f : Symbol(f, Decl(a.js, 67, 3), Decl(b.ts, 22, 3))

/** @type {new (s: string) => { s: string }} */
var ctor;
>ctor : Symbol(ctor, Decl(a.js, 64, 3), Decl(b.ts, 21, 3))
>ctor : Symbol(ctor, Decl(a.js, 70, 3), Decl(b.ts, 23, 3))

=== b.ts ===
var S: string;
Expand All @@ -103,62 +111,68 @@ var n: number
>n : Symbol(n, Decl(a.js, 10, 3), Decl(b.ts, 3, 3))

var B: boolean;
>B : Symbol(B, Decl(a.js, 13, 3), Decl(b.ts, 4, 3))
>B : Symbol(B, Decl(a.js, 19, 3), Decl(b.ts, 4, 3))

var b: boolean;
>b : Symbol(b, Decl(a.js, 16, 3), Decl(b.ts, 5, 3))
>b : Symbol(b, Decl(a.js, 22, 3), Decl(b.ts, 5, 3))

var BI: bigint;
>BI : Symbol(BI, Decl(a.js, 13, 3), Decl(b.ts, 6, 3))

var bi: bigint;
>bi : Symbol(bi, Decl(a.js, 16, 3), Decl(b.ts, 7, 3))

var V :void;
>V : Symbol(V, Decl(a.js, 19, 3), Decl(b.ts, 6, 3))
>V : Symbol(V, Decl(a.js, 25, 3), Decl(b.ts, 8, 3))

var v: void;
>v : Symbol(v, Decl(a.js, 22, 3), Decl(b.ts, 7, 3))
>v : Symbol(v, Decl(a.js, 28, 3), Decl(b.ts, 9, 3))

var U: undefined;
>U : Symbol(U, Decl(a.js, 25, 3), Decl(b.ts, 8, 3))
>U : Symbol(U, Decl(a.js, 31, 3), Decl(b.ts, 10, 3))

var u: undefined;
>u : Symbol(u, Decl(a.js, 28, 3), Decl(b.ts, 9, 3))
>u : Symbol(u, Decl(a.js, 34, 3), Decl(b.ts, 11, 3))

var Nl: null;
>Nl : Symbol(Nl, Decl(a.js, 31, 3), Decl(b.ts, 10, 3))
>Nl : Symbol(Nl, Decl(a.js, 37, 3), Decl(b.ts, 12, 3))

var nl: null;
>nl : Symbol(nl, Decl(a.js, 34, 3), Decl(b.ts, 11, 3))
>nl : Symbol(nl, Decl(a.js, 40, 3), Decl(b.ts, 13, 3))

var A: any[];
>A : Symbol(A, Decl(a.js, 37, 3), Decl(b.ts, 12, 3))
>A : Symbol(A, Decl(a.js, 43, 3), Decl(b.ts, 14, 3))

var a: any[];
>a : Symbol(a, Decl(a.js, 40, 3), Decl(b.ts, 13, 3))
>a : Symbol(a, Decl(a.js, 46, 3), Decl(b.ts, 15, 3))

var P: Promise<any>;
>P : Symbol(P, Decl(a.js, 43, 3), Decl(b.ts, 14, 3))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --))
>P : Symbol(P, Decl(a.js, 49, 3), Decl(b.ts, 16, 3))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2018.promise.d.ts, --, --))

var p: Promise<any>;
>p : Symbol(p, Decl(a.js, 46, 3), Decl(b.ts, 15, 3))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --))
>p : Symbol(p, Decl(a.js, 52, 3), Decl(b.ts, 17, 3))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2018.promise.d.ts, --, --))

var nullable: number | null;
>nullable : Symbol(nullable, Decl(a.js, 49, 3), Decl(b.ts, 16, 3))
>nullable : Symbol(nullable, Decl(a.js, 55, 3), Decl(b.ts, 18, 3))

var Obj: any;
>Obj : Symbol(Obj, Decl(a.js, 52, 3), Decl(b.ts, 17, 3))
>Obj : Symbol(Obj, Decl(a.js, 58, 3), Decl(b.ts, 19, 3))

var obj: any;
>obj : Symbol(obj, Decl(a.js, 55, 3), Decl(b.ts, 18, 3))
>obj : Symbol(obj, Decl(a.js, 61, 3), Decl(b.ts, 20, 3))

var Func: Function;
>Func : Symbol(Func, Decl(a.js, 58, 3), Decl(b.ts, 19, 3))
>Function : Symbol(Function, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
>Func : Symbol(Func, Decl(a.js, 64, 3), Decl(b.ts, 21, 3))
>Function : Symbol(Function, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.core.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.esnext.decorators.d.ts, --, --))

var f: (s: string) => number;
>f : Symbol(f, Decl(a.js, 61, 3), Decl(b.ts, 20, 3))
>s : Symbol(s, Decl(b.ts, 20, 8))
>f : Symbol(f, Decl(a.js, 67, 3), Decl(b.ts, 22, 3))
>s : Symbol(s, Decl(b.ts, 22, 8))

var ctor: new (s: string) => { s: string };
>ctor : Symbol(ctor, Decl(a.js, 64, 3), Decl(b.ts, 21, 3))
>s : Symbol(s, Decl(b.ts, 21, 15))
>s : Symbol(s, Decl(b.ts, 21, 30))
>ctor : Symbol(ctor, Decl(a.js, 70, 3), Decl(b.ts, 23, 3))
>s : Symbol(s, Decl(b.ts, 23, 15))
>s : Symbol(s, Decl(b.ts, 23, 30))

18 changes: 18 additions & 0 deletions tests/baselines/reference/jsdocTypeTag.types
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ var n;
>n : number
> : ^^^^^^

/** @type {BigInt} */
var BI;
>BI : bigint
> : ^^^^^^

/** @type {bigint} */
var bi;
>bi : bigint
> : ^^^^^^

/** @type {Boolean} */
var B;
>B : boolean
Expand Down Expand Up @@ -134,6 +144,14 @@ var b: boolean;
>b : boolean
> : ^^^^^^^

var BI: bigint;
>BI : bigint
> : ^^^^^^

var bi: bigint;
>bi : bigint
> : ^^^^^^

var V :void;
>V : void
> : ^^^^
Expand Down
15 changes: 15 additions & 0 deletions tests/cases/conformance/jsdoc/checkJsdocTypeTag8.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// @strict: true
// @allowJs: true
// @checkJs: true
// @noEmit: true

// @filename: index.js

// https://github.com/microsoft/TypeScript/issues/57953

/**
* @param {Number|BigInt} n
*/
function isLessThanFive(n) {
return n < 5;
}
9 changes: 9 additions & 0 deletions tests/cases/conformance/jsdoc/jsdocTypeTag.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
// @allowJS: true
// @target: esnext
// @suppressOutputPathCheck: true
// @strictNullChecks: true

Expand All @@ -15,6 +16,12 @@ var N;
/** @type {number} */
var n;

/** @type {BigInt} */
var BI;

/** @type {bigint} */
var bi;

/** @type {Boolean} */
var B;

Expand Down Expand Up @@ -76,6 +83,8 @@ var N: number;
var n: number
var B: boolean;
var b: boolean;
var BI: bigint;
var bi: bigint;
var V :void;
var v: void;
var U: undefined;
Expand Down
Loading