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

Fixes for type parameter name resolution in JS #26830

Merged
merged 3 commits into from
Sep 4, 2018
Merged

Fixes for type parameter name resolution in JS #26830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4589db5
check for expando initializers in resolveEntityName
sandersn Aug 31, 2018
9c6cf79
Lookup type parameters on prototype-assignment methods
sandersn Aug 31, 2018
e68e3c2
Look up types on property assignments too
sandersn Sep 4, 2018
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
24 changes: 22 additions & 2 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2140,7 +2140,7 @@ namespace ts {
}
}

function getJSSpecialAssignmentLocation(node: TypeReferenceNode): Declaration | undefined {
function getJSSpecialAssignmentLocation(node: TypeReferenceNode): Node | undefined {
const typeAlias = findAncestor(node, node => !(isJSDocNode(node) || node.flags & NodeFlags.JSDoc) ? "quit" : isJSDocTypeAlias(node));
if (typeAlias) {
return;
Expand All @@ -2149,8 +2149,20 @@ namespace ts {
if (isExpressionStatement(host) &&
isBinaryExpression(host.expression) &&
getSpecialPropertyAssignmentKind(host.expression) === SpecialPropertyAssignmentKind.PrototypeProperty) {
// X.prototype.m = /** @param {K} p */ function () { } <-- look for K on X's declaration
const symbol = getSymbolOfNode(host.expression.left);
return symbol && symbol.parent!.valueDeclaration;
if (symbol) {
return getDeclarationOfJSPrototypeContainer(symbol);
}
}
if ((isObjectLiteralMethod(host) || isPropertyAssignment(host)) &&
isBinaryExpression(host.parent.parent) &&
getSpecialPropertyAssignmentKind(host.parent.parent) === SpecialPropertyAssignmentKind.Prototype) {
// X.prototype = { /** @param {K} p */m() { } } <-- look for K on X's declaration
const symbol = getSymbolOfNode(host.parent.parent.left);
if (symbol) {
return getDeclarationOfJSPrototypeContainer(symbol);
}
}
const sig = getHostSignatureFromJSDocHost(host);
if (sig) {
Expand All @@ -2159,6 +2171,14 @@ namespace ts {
}
}

function getDeclarationOfJSPrototypeContainer(symbol: Symbol) {
const decl = symbol.parent!.valueDeclaration;
const initializer = isAssignmentDeclaration(decl) ? getAssignedJavascriptInitializer(decl) :
hasOnlyExpressionInitializer(decl) ? getDeclaredJavascriptInitializer(decl) :
undefined;
return initializer || decl;
}

function resolveExternalModuleName(location: Node, moduleReferenceExpression: Expression): Symbol | undefined {
return resolveExternalModuleNameWorker(location, moduleReferenceExpression, Diagnostics.Cannot_find_module_0);
}
Expand Down
113 changes: 113 additions & 0 deletions tests/baselines/reference/jsdocTemplateTag4.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
=== tests/cases/conformance/jsdoc/a.js ===
/**
* Should work for function declarations
* @constructor
* @template {string} K
* @template V
*/
function Multimap() {
>Multimap : Symbol(Multimap, Decl(a.js, 0, 0))

/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
>this._map : Symbol(Multimap._map, Decl(a.js, 6, 21))
>this : Symbol(Multimap, Decl(a.js, 0, 0))
>_map : Symbol(Multimap._map, Decl(a.js, 6, 21))

};

/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
Multimap.prototype.get = function (key) {
>Multimap.prototype : Symbol(Multimap.get, Decl(a.js, 9, 2))
>Multimap : Symbol(Multimap, Decl(a.js, 0, 0))
>prototype : Symbol(Function.prototype, Decl(lib.es5.d.ts, --, --))
>get : Symbol(Multimap.get, Decl(a.js, 9, 2))
>key : Symbol(key, Decl(a.js, 15, 35))

return this._map[key + ''];
>this._map : Symbol(Multimap._map, Decl(a.js, 6, 21))
>this : Symbol(Multimap, Decl(a.js, 0, 0))
>_map : Symbol(Multimap._map, Decl(a.js, 6, 21))
>key : Symbol(key, Decl(a.js, 15, 35))
}

/**
* Should work for initialisers too
* @constructor
* @template {string} K
* @template V
*/
var Multimap2 = function() {
>Multimap2 : Symbol(Multimap2, Decl(a.js, 25, 3))

/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
>this._map : Symbol(Multimap2._map, Decl(a.js, 25, 28))
>this : Symbol(Multimap2, Decl(a.js, 25, 15))
>_map : Symbol(Multimap2._map, Decl(a.js, 25, 28))

};

/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
Multimap2.prototype.get = function (key) {
>Multimap2.prototype : Symbol(Multimap2.get, Decl(a.js, 28, 2))
>Multimap2 : Symbol(Multimap2, Decl(a.js, 25, 3))
>prototype : Symbol(Function.prototype, Decl(lib.es5.d.ts, --, --))
>get : Symbol(Multimap2.get, Decl(a.js, 28, 2))
>key : Symbol(key, Decl(a.js, 34, 36))

return this._map[key + ''];
>this._map : Symbol(Multimap2._map, Decl(a.js, 25, 28))
>this : Symbol(Multimap2, Decl(a.js, 25, 15))
>_map : Symbol(Multimap2._map, Decl(a.js, 25, 28))
>key : Symbol(key, Decl(a.js, 34, 36))
}

var Ns = {};
>Ns : Symbol(Ns, Decl(a.js, 38, 3), Decl(a.js, 38, 12))

/**
* Should work for expando-namespaced initialisers too
* @constructor
* @template {string} K
* @template V
*/
Ns.Multimap3 = function() {
>Ns.Multimap3 : Symbol(Ns.Multimap3, Decl(a.js, 38, 12))
>Ns : Symbol(Ns, Decl(a.js, 38, 3), Decl(a.js, 38, 12))
>Multimap3 : Symbol(Ns.Multimap3, Decl(a.js, 38, 12))

/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
>this._map : Symbol(Multimap3._map, Decl(a.js, 45, 27))
>this : Symbol(Multimap3, Decl(a.js, 45, 14))
>_map : Symbol(Multimap3._map, Decl(a.js, 45, 27))

};

/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
Ns.Multimap3.prototype.get = function (key) {
>Ns.Multimap3.prototype : Symbol(Ns.Multimap3.get, Decl(a.js, 48, 2))
>Ns.Multimap3 : Symbol(Ns.Multimap3, Decl(a.js, 38, 12))
>Ns : Symbol(Ns, Decl(a.js, 38, 3), Decl(a.js, 38, 12))
>Multimap3 : Symbol(Ns.Multimap3, Decl(a.js, 38, 12))
>prototype : Symbol(Function.prototype, Decl(lib.es5.d.ts, --, --))
>get : Symbol(Ns.Multimap3.get, Decl(a.js, 48, 2))
>key : Symbol(key, Decl(a.js, 54, 39))

return this._map[key + ''];
>this._map : Symbol(Multimap3._map, Decl(a.js, 45, 27))
>this : Symbol(Multimap3, Decl(a.js, 45, 14))
>_map : Symbol(Multimap3._map, Decl(a.js, 45, 27))
>key : Symbol(key, Decl(a.js, 54, 39))
}

141 changes: 141 additions & 0 deletions tests/baselines/reference/jsdocTemplateTag4.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
=== tests/cases/conformance/jsdoc/a.js ===
/**
* Should work for function declarations
* @constructor
* @template {string} K
* @template V
*/
function Multimap() {
>Multimap : typeof Multimap

/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
>this._map = {} : {}
>this._map : { [x: string]: V; }
>this : Multimap
>_map : { [x: string]: V; }
>{} : {}

};

/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
Multimap.prototype.get = function (key) {
>Multimap.prototype.get = function (key) { return this._map[key + ''];} : (key: K) => V
>Multimap.prototype.get : any
>Multimap.prototype : any
>Multimap : typeof Multimap
>prototype : any
>get : any
>function (key) { return this._map[key + ''];} : (key: K) => V
>key : K

return this._map[key + ''];
>this._map[key + ''] : V
>this._map : { [x: string]: V; }
>this : Multimap
>_map : { [x: string]: V; }
>key + '' : string
>key : K
>'' : ""
}

/**
* Should work for initialisers too
* @constructor
* @template {string} K
* @template V
*/
var Multimap2 = function() {
>Multimap2 : typeof Multimap2
>function() { /** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */ this._map = {};} : typeof Multimap2

/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
>this._map = {} : {}
>this._map : { [x: string]: V; }
>this : Multimap2
>_map : { [x: string]: V; }
>{} : {}

};

/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
Multimap2.prototype.get = function (key) {
>Multimap2.prototype.get = function (key) { return this._map[key + ''];} : (key: K) => V
>Multimap2.prototype.get : any
>Multimap2.prototype : any
>Multimap2 : typeof Multimap2
>prototype : any
>get : any
>function (key) { return this._map[key + ''];} : (key: K) => V
>key : K

return this._map[key + ''];
>this._map[key + ''] : V
>this._map : { [x: string]: V; }
>this : Multimap2
>_map : { [x: string]: V; }
>key + '' : string
>key : K
>'' : ""
}

var Ns = {};
>Ns : typeof Ns
>{} : {}

/**
* Should work for expando-namespaced initialisers too
* @constructor
* @template {string} K
* @template V
*/
Ns.Multimap3 = function() {
>Ns.Multimap3 = function() { /** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */ this._map = {};} : typeof Multimap3
>Ns.Multimap3 : typeof Multimap3
>Ns : typeof Ns
>Multimap3 : typeof Multimap3
>function() { /** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */ this._map = {};} : typeof Multimap3

/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
>this._map = {} : {}
>this._map : { [x: string]: V; }
>this : Multimap3
>_map : { [x: string]: V; }
>{} : {}

};

/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
Ns.Multimap3.prototype.get = function (key) {
>Ns.Multimap3.prototype.get = function (key) { return this._map[key + ''];} : (key: K) => V
>Ns.Multimap3.prototype.get : any
>Ns.Multimap3.prototype : any
>Ns.Multimap3 : typeof Multimap3
>Ns : typeof Ns
>Multimap3 : typeof Multimap3
>prototype : any
>get : any
>function (key) { return this._map[key + ''];} : (key: K) => V
>key : K

return this._map[key + ''];
>this._map[key + ''] : V
>this._map : { [x: string]: V; }
>this : Multimap3
>_map : { [x: string]: V; }
>key + '' : string
>key : K
>'' : ""
}

77 changes: 77 additions & 0 deletions tests/baselines/reference/jsdocTemplateTag5.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
tests/cases/conformance/jsdoc/a.js(18,21): error TS2339: Property '_map' does not exist on type '{ get(key: K): V; }'.
tests/cases/conformance/jsdoc/a.js(39,21): error TS2339: Property '_map' does not exist on type '{ get: (key: K) => V; }'.
tests/cases/conformance/jsdoc/a.js(61,21): error TS2339: Property '_map' does not exist on type '{ get(key: K): V; }'.


==== tests/cases/conformance/jsdoc/a.js (3 errors) ====
/**
* Should work for function declarations
* @constructor
* @template {string} K
* @template V
*/
function Multimap() {
/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
};

Multimap.prototype = {
/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
get(key) {
return this._map[key + ''];
~~~~
!!! error TS2339: Property '_map' does not exist on type '{ get(key: K): V; }'.
}
}

/**
* Should work for initialisers too
* @constructor
* @template {string} K
* @template V
*/
var Multimap2 = function() {
/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
};

Multimap2.prototype = {
/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
get: function(key) {
return this._map[key + ''];
~~~~
!!! error TS2339: Property '_map' does not exist on type '{ get: (key: K) => V; }'.
}
}

var Ns = {};
/**
* Should work for expando-namespaced initialisers too
* @constructor
* @template {string} K
* @template V
*/
Ns.Multimap3 = function() {
/** @type {Object<string, V>} TODO: Remove the prototype from the fresh object */
this._map = {};
};

Ns.Multimap3.prototype = {
/**
* @param {K} key the key ok
* @returns {V} the value ok
*/
get(key) {
return this._map[key + ''];
~~~~
!!! error TS2339: Property '_map' does not exist on type '{ get(key: K): V; }'.
}
}


Loading