microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-05 08:11:30 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Fix crash on aliased,exported @enum tag in jsdoc (#36996)

Browse Source 
THe code to bind `@enum` and `@typedef` didn't handle the case that the
`@enum` was on a property assignment to an alias of module.exports.
Specifically, `x` needs to be correctly aliased to the file's symbol in
the example below:

```
var x = module.exports = {};
/** @enum {string} */
x.E = {
  A: "A"
};
```
This commit is contained in:
Nathan Shively-Sanders 2020-02-24 16:13:18 -08:00 committed by GitHub
parent 65e7acce58
commit 3e3df8702c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/compiler/binder.ts
View File

@ -2113,7 +2113,9 @@ namespace ts {
container = (declName.parent.expression as PropertyAccessExpression).name;
break;
case AssignmentDeclarationKind.Property:
container = isPropertyAccessExpression(declName.parent.expression) ? declName.parent.expression.name : declName.parent.expression;
container = isExportsOrModuleExportsOrAlias(file, declName.parent.expression) ? file
: isPropertyAccessExpression(declName.parent.expression) ? declName.parent.expression.name
: declName.parent.expression;
break;
case AssignmentDeclarationKind.None:
return Debug.fail("Shouldn't have detected typedef or enum on non-assignment declaration");

18
tests/baselines/reference/exportedAliasedEnumTag.symbols Normal file
View File

@ -0,0 +1,18 @@
=== tests/cases/conformance/jsdoc/exportedAliasedEnumTag.js ===
var middlewarify = module.exports = {};
>middlewarify : Symbol(middlewarify, Decl(exportedAliasedEnumTag.js, 0, 3))
>module.exports : Symbol("tests/cases/conformance/jsdoc/exportedAliasedEnumTag", Decl(exportedAliasedEnumTag.js, 0, 0))
>module : Symbol(module, Decl(exportedAliasedEnumTag.js, 0, 18))
>exports : Symbol("tests/cases/conformance/jsdoc/exportedAliasedEnumTag", Decl(exportedAliasedEnumTag.js, 0, 0))
/** @enum */
middlewarify.Type = {
>middlewarify.Type : Symbol(Type, Decl(exportedAliasedEnumTag.js, 0, 39), Decl(exportedAliasedEnumTag.js, 3, 13), Decl(exportedAliasedEnumTag.js, 2, 4))
>middlewarify : Symbol(middlewarify, Decl(exportedAliasedEnumTag.js, 0, 3))
>Type : Symbol(Type, Decl(exportedAliasedEnumTag.js, 0, 39), Decl(exportedAliasedEnumTag.js, 3, 13), Decl(exportedAliasedEnumTag.js, 2, 4))
BEFORE: 'before'
>BEFORE : Symbol(BEFORE, Decl(exportedAliasedEnumTag.js, 3, 21))
};

23
tests/baselines/reference/exportedAliasedEnumTag.types Normal file
View File

@ -0,0 +1,23 @@
=== tests/cases/conformance/jsdoc/exportedAliasedEnumTag.js ===
var middlewarify = module.exports = {};
>middlewarify : typeof import("tests/cases/conformance/jsdoc/exportedAliasedEnumTag")
>module.exports = {} : typeof import("tests/cases/conformance/jsdoc/exportedAliasedEnumTag")
>module.exports : typeof import("tests/cases/conformance/jsdoc/exportedAliasedEnumTag")
>module : { "\"tests/cases/conformance/jsdoc/exportedAliasedEnumTag\"": typeof import("tests/cases/conformance/jsdoc/exportedAliasedEnumTag"); }
>exports : typeof import("tests/cases/conformance/jsdoc/exportedAliasedEnumTag")
>{} : {}
/** @enum */
middlewarify.Type = {
>middlewarify.Type = { BEFORE: 'before'} : { BEFORE: string; }
>middlewarify.Type : { BEFORE: string; }
>middlewarify : typeof import("tests/cases/conformance/jsdoc/exportedAliasedEnumTag")
>Type : { BEFORE: string; }
>{ BEFORE: 'before'} : { BEFORE: string; }
BEFORE: 'before'
>BEFORE : string
>'before' : "before"
};

9
tests/cases/conformance/jsdoc/exportedAliasedEnumTag.ts Normal file
View File

@ -0,0 +1,9 @@
// @noemit: true
// @allowjs: true
// @filename: exportedAliasedEnumTag.js
var middlewarify = module.exports = {};
/** @enum */
middlewarify.Type = {
BEFORE: 'before'
};