Skip to content

Avoid a crash with @typedef in a script file. #33847

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

Merged
merged 3 commits into from
Oct 24, 2019
Merged

Avoid a crash with @typedef in a script file. #33847

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
97dcbd3
Avoid a crash with `@typedef` in a script file.
mprobst Oct 7, 2019
f9b7d6e
Add usage of exports.SomeName typedef.
mprobst Oct 16, 2019
92dc69d
Fix bug at bind site rather than in declare func
weswigham Oct 23, 2019
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
11 changes: 9 additions & 2 deletions src/compiler/binder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2003,7 +2003,12 @@ namespace ts {
switch (getAssignmentDeclarationPropertyAccessKind(declName.parent)) {
case AssignmentDeclarationKind.ExportsProperty:
case AssignmentDeclarationKind.ModuleExports:
container = file;
if (!isExternalOrCommonJsModule(file)) {
container = undefined!;
}
else {
container = file;
}
break;
case AssignmentDeclarationKind.ThisProperty:
container = declName.parent.expression;
Expand All @@ -2017,7 +2022,9 @@ namespace ts {
case AssignmentDeclarationKind.None:
return Debug.fail("Shouldn't have detected typedef or enum on non-assignment declaration");
}
declareModuleMember(typeAlias, SymbolFlags.TypeAlias, SymbolFlags.TypeAliasExcludes);
if (container) {
declareModuleMember(typeAlias, SymbolFlags.TypeAlias, SymbolFlags.TypeAliasExcludes);
}
container = oldContainer;
}
}
Expand Down
18 changes: 18 additions & 0 deletions tests/baselines/reference/checkJsdocTypedefOnlySourceFile.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
tests/cases/conformance/jsdoc/0.js(10,20): error TS2694: Namespace 'exports' has no exported member 'SomeName'.


==== tests/cases/conformance/jsdoc/0.js (1 errors) ====
// @ts-check

var exports = {};

/**
* @typedef {string}
*/
exports.SomeName;

/** @type {exports.SomeName} */
~~~~~~~~
!!! error TS2694: Namespace 'exports' has no exported member 'SomeName'.
const myString = 'str';

23 changes: 23 additions & 0 deletions tests/baselines/reference/checkJsdocTypedefOnlySourceFile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
//// [0.js]
// @ts-check

var exports = {};

/**
* @typedef {string}
*/
exports.SomeName;
Copy link
Member

Choose a reason for hiding this comment

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

is there a way this typedef can be used? The test should try, if only so we can see the error if it fails.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, it cannot be used, see the additional commit I pushed. The typedef essentially goes ignored due to the added check for container.symbol (which is false in files that are not modules).


/** @type {exports.SomeName} */
const myString = 'str';


//// [0.js]
// @ts-check
var exports = {};
/**
* @typedef {string}
*/
exports.SomeName;
/** @type {exports.SomeName} */
var myString = 'str';
16 changes: 16 additions & 0 deletions tests/baselines/reference/checkJsdocTypedefOnlySourceFile.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
=== tests/cases/conformance/jsdoc/0.js ===
// @ts-check

var exports = {};
>exports : Symbol(exports, Decl(0.js, 2, 3))

/**
* @typedef {string}
*/
exports.SomeName;
>exports : Symbol(exports, Decl(0.js, 2, 3))

/** @type {exports.SomeName} */
const myString = 'str';
>myString : Symbol(myString, Decl(0.js, 10, 5))

20 changes: 20 additions & 0 deletions tests/baselines/reference/checkJsdocTypedefOnlySourceFile.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
=== tests/cases/conformance/jsdoc/0.js ===
// @ts-check

var exports = {};
>exports : {}
>{} : {}

/**
* @typedef {string}
*/
exports.SomeName;
>exports.SomeName : any
>exports : {}
>SomeName : any

/** @type {exports.SomeName} */
const myString = 'str';
>myString : any
>'str' : "str"

15 changes: 15 additions & 0 deletions tests/cases/conformance/jsdoc/checkJsdocTypedefOnlySourceFile.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// @allowJS: true
// @suppressOutputPathCheck: true

// @filename: 0.js
// @ts-check

var exports = {};

/**
* @typedef {string}
*/
exports.SomeName;

/** @type {exports.SomeName} */
const myString = 'str';