Microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2025-11-18 17:21:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix assert in getjsdochost (#23575)

Browse Source 
* Fix assert in getJSDocHost

* Update public API to add wider type

* Remove now-unnecessary type assertion
This commit is contained in:
Nathan Shively-Sanders
2018-04-20 10:41:58 -07:00
committed by GitHub
parent 22f2b118b7
commit e65681a2b7
8 changed files with 190 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/compiler/types.ts
+1 -1
View File
@@ -2332,7 +2332,7 @@ namespace ts {
}
export interface JSDocTag extends Node {
parent: JSDoc;
parent: JSDoc | JSDocTypeLiteral;
atToken: AtToken;
tagName: Identifier;
comment: string | undefined;
src/compiler/utilities.ts
+3
View File
@@ -1888,6 +1888,9 @@ namespace ts {
}
export function getJSDocHost(node: JSDocTag): HasJSDoc {
while (node.parent.kind === SyntaxKind.JSDocTypeLiteral) {
node = node.parent.parent.parent as JSDocParameterTag;
}
Debug.assert(node.parent!.kind === SyntaxKind.JSDocComment);
return node.parent!.parent!;
}
tests/baselines/reference/api/tsserverlibrary.d.ts
Vendored
+1 -1
View File
@@ -1494,7 +1494,7 @@ declare namespace ts {
comment: string | undefined;
}
interface JSDocTag extends Node {
parent: JSDoc;
parent: JSDoc | JSDocTypeLiteral;
atToken: AtToken;
tagName: Identifier;
comment: string | undefined;
tests/baselines/reference/api/typescript.d.ts
Vendored
+1 -1
View File
@@ -1494,7 +1494,7 @@ declare namespace ts {
comment: string | undefined;
}
interface JSDocTag extends Node {
parent: JSDoc;
parent: JSDoc | JSDocTypeLiteral;
atToken: AtToken;
tagName: Identifier;
comment: string | undefined;
tests/baselines/reference/jsdocTemplateConstructorFunction2.errors.txt
+28
View File
@@ -0,0 +1,28 @@
tests/cases/conformance/jsdoc/templateTagWithNestedTypeLiteral.js(21,1): error TS2322: Type 'false' is not assignable to type 'number'.
==== tests/cases/conformance/jsdoc/templateTagWithNestedTypeLiteral.js (1 errors) ====
/**
* @template {T}
* @param {T} t
*/
function Zet(t) {
/** @type {T} */
this.u
this.t = t
}
/**
* @param {T} v
* @param {object} o
* @param {T} o.nested
*/
Zet.prototype.add = function(v, o) {
this.u = v || o.nested
return this.u
}
var z = new Zet(1)
z.t = 2
z.u = false
~~~
!!! error TS2322: Type 'false' is not assignable to type 'number'.
tests/baselines/reference/jsdocTemplateConstructorFunction2.symbols
+56
View File
@@ -0,0 +1,56 @@
=== tests/cases/conformance/jsdoc/templateTagWithNestedTypeLiteral.js ===
/**
* @template {T}
* @param {T} t
*/
function Zet(t) {
>Zet : Symbol(Zet, Decl(templateTagWithNestedTypeLiteral.js, 0, 0))
>t : Symbol(t, Decl(templateTagWithNestedTypeLiteral.js, 4, 13))
/** @type {T} */
this.u
this.t = t
>t : Symbol(Zet.t, Decl(templateTagWithNestedTypeLiteral.js, 6, 10))
>t : Symbol(t, Decl(templateTagWithNestedTypeLiteral.js, 4, 13))
}
/**
* @param {T} v
* @param {object} o
* @param {T} o.nested
*/
Zet.prototype.add = function(v, o) {
>Zet.prototype : Symbol(Zet.add, Decl(templateTagWithNestedTypeLiteral.js, 8, 1))
>Zet : Symbol(Zet, Decl(templateTagWithNestedTypeLiteral.js, 0, 0))
>prototype : Symbol(Function.prototype, Decl(lib.d.ts, --, --))
>add : Symbol(Zet.add, Decl(templateTagWithNestedTypeLiteral.js, 8, 1))
>v : Symbol(v, Decl(templateTagWithNestedTypeLiteral.js, 14, 29))
>o : Symbol(o, Decl(templateTagWithNestedTypeLiteral.js, 14, 31))
this.u = v || o.nested
>this.u : Symbol(Zet.u, Decl(templateTagWithNestedTypeLiteral.js, 4, 17), Decl(templateTagWithNestedTypeLiteral.js, 14, 36))
>this : Symbol(Zet, Decl(templateTagWithNestedTypeLiteral.js, 0, 0))
>u : Symbol(Zet.u, Decl(templateTagWithNestedTypeLiteral.js, 4, 17), Decl(templateTagWithNestedTypeLiteral.js, 14, 36))
>v : Symbol(v, Decl(templateTagWithNestedTypeLiteral.js, 14, 29))
>o.nested : Symbol(nested, Decl(templateTagWithNestedTypeLiteral.js, 12, 3))
>o : Symbol(o, Decl(templateTagWithNestedTypeLiteral.js, 14, 31))
>nested : Symbol(nested, Decl(templateTagWithNestedTypeLiteral.js, 12, 3))
return this.u
>this.u : Symbol(Zet.u, Decl(templateTagWithNestedTypeLiteral.js, 4, 17), Decl(templateTagWithNestedTypeLiteral.js, 14, 36))
>this : Symbol(Zet, Decl(templateTagWithNestedTypeLiteral.js, 0, 0))
>u : Symbol(Zet.u, Decl(templateTagWithNestedTypeLiteral.js, 4, 17), Decl(templateTagWithNestedTypeLiteral.js, 14, 36))
}
var z = new Zet(1)
>z : Symbol(z, Decl(templateTagWithNestedTypeLiteral.js, 18, 3))
>Zet : Symbol(Zet, Decl(templateTagWithNestedTypeLiteral.js, 0, 0))
z.t = 2
>z.t : Symbol(Zet.t, Decl(templateTagWithNestedTypeLiteral.js, 6, 10))
>z : Symbol(z, Decl(templateTagWithNestedTypeLiteral.js, 18, 3))
>t : Symbol(Zet.t, Decl(templateTagWithNestedTypeLiteral.js, 6, 10))
z.u = false
>z.u : Symbol(Zet.u, Decl(templateTagWithNestedTypeLiteral.js, 4, 17), Decl(templateTagWithNestedTypeLiteral.js, 14, 36))
>z : Symbol(z, Decl(templateTagWithNestedTypeLiteral.js, 18, 3))
>u : Symbol(Zet.u, Decl(templateTagWithNestedTypeLiteral.js, 4, 17), Decl(templateTagWithNestedTypeLiteral.js, 14, 36))
tests/baselines/reference/jsdocTemplateConstructorFunction2.types
+74
View File
@@ -0,0 +1,74 @@
=== tests/cases/conformance/jsdoc/templateTagWithNestedTypeLiteral.js ===
/**
* @template {T}
* @param {T} t
*/
function Zet(t) {
>Zet : typeof Zet
>t : T
/** @type {T} */
this.u
>this.u : any
>this : any
>u : any
this.t = t
>this.t = t : T
>this.t : any
>this : any
>t : any
>t : T
}
/**
* @param {T} v
* @param {object} o
* @param {T} o.nested
*/
Zet.prototype.add = function(v, o) {
>Zet.prototype.add = function(v, o) { this.u = v || o.nested return this.u} : (v: T, o: { nested: T; }) => T
>Zet.prototype.add : any
>Zet.prototype : any
>Zet : typeof Zet
>prototype : any
>add : any
>function(v, o) { this.u = v || o.nested return this.u} : (v: T, o: { nested: T; }) => T
>v : T
>o : { nested: T; }
this.u = v || o.nested
>this.u = v || o.nested : T
>this.u : T
>this : Zet
>u : T
>v || o.nested : T
>v : T
>o.nested : T
>o : { nested: T; }
>nested : T
return this.u
>this.u : T
>this : Zet
>u : T
}
var z = new Zet(1)
>z : typeof Zet
>new Zet(1) : typeof Zet
>Zet : typeof Zet
>1 : 1
z.t = 2
>z.t = 2 : 2
>z.t : number
>z : typeof Zet
>t : number
>2 : 2
z.u = false
>z.u = false : false
>z.u : number
>z : typeof Zet
>u : number
>false : false
tests/cases/conformance/jsdoc/jsdocTemplateConstructorFunction2.ts
+26
View File
@@ -0,0 +1,26 @@
// @allowJs: true
// @checkJs: true
// @noEmit: true
// @Filename: templateTagWithNestedTypeLiteral.js
/**
* @template {T}
* @param {T} t
*/
function Zet(t) {
/** @type {T} */
this.u
this.t = t
}
/**
* @param {T} v
* @param {object} o
* @param {T} o.nested
*/
Zet.prototype.add = function(v, o) {
this.u = v || o.nested
return this.u
}
var z = new Zet(1)
z.t = 2
z.u = false