Skip to content

Don't treat object properties as potential JS contructors without JSDoc class tag #49735

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 5 commits into from
Aug 10, 2022
Merged

Don't treat object properties as potential JS contructors without JSDoc class tag #49735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9357739
Add test case
jakebailey Jun 29, 2022
88b88aa
Don't treat object properties as potential JS contructors without JSD…
jakebailey Jun 29, 2022
4f58a1b
Handle object literal methods
jakebailey Jun 30, 2022
086c8c9
Don't handle methods
jakebailey Jul 6, 2022
532c2bb
Use correct node for property assignment check
jakebailey Jul 6, 2022
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
7 changes: 5 additions & 2 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31689,12 +31689,15 @@ namespace ts {
return false;
}
const func = isFunctionDeclaration(node) || isFunctionExpression(node) ? node :
isVariableDeclaration(node) && node.initializer && isFunctionExpression(node.initializer) ? node.initializer :
(isVariableDeclaration(node) || isPropertyAssignment(node)) && node.initializer && isFunctionExpression(node.initializer) ? node.initializer :
undefined;
if (func) {
// If the node has a @class tag, treat it like a constructor.
// If the node has a @class or @constructor tag, treat it like a constructor.
if (getJSDocClassTag(node)) return true;

// If the node is a property of an object literal.
if (isPropertyAssignment(walkUpParenthesizedExpressions(func.parent))) return false;

// If the symbol of the node has members, treat it like a constructor.
const symbol = getSymbolOfNode(func);
return !!symbol?.members?.size;
Expand Down
3 changes: 1 addition & 2 deletions tests/baselines/reference/functionExpressionNames.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ var o = {
>C : Symbol(C, Decl(b.js, 5, 9))

this.c = 'nested object'
>this.c : Symbol(C.c, Decl(b.js, 6, 20))
>this : Symbol(C, Decl(b.js, 6, 6))
>this : Symbol(o, Decl(b.js, 5, 7))
>c : Symbol(C.c, Decl(b.js, 6, 20))
}
}
Expand Down
2 changes: 1 addition & 1 deletion tests/baselines/reference/functionExpressionNames.types
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ var o = {
this.c = 'nested object'
>this.c = 'nested object' : "nested object"
>this.c : any
>this : this
>this : { C: typeof C; }
Copy link
Member Author

Choose a reason for hiding this comment

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

This test is explicitly the case that is changing:

var o = {
    C: function () {
        this.c = 'nested object'
    }
}
var og = new o.C();

So, I'm not sure if that's good or bad.

>c : any
>'nested object' : "nested object"
}
Expand Down
52 changes: 52 additions & 0 deletions tests/baselines/reference/objectPropertyAsClass.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
=== tests/cases/compiler/index.js ===
const a1 = {
>a1 : Symbol(a1, Decl(index.js, 0, 5))

foo() {
>foo : Symbol(foo, Decl(index.js, 0, 12))

this.x = 0;
>this : Symbol(a1, Decl(index.js, 0, 10))
>x : Symbol(x, Decl(index.js, 1, 11))
}
}

const a2 = {
>a2 : Symbol(a2, Decl(index.js, 6, 5))

foo: function() {
>foo : Symbol(foo, Decl(index.js, 6, 12))

this.x = 0;
>this : Symbol(a2, Decl(index.js, 6, 10))
>x : Symbol(foo.x, Decl(index.js, 7, 21))
}
}

const b1 = {
>b1 : Symbol(b1, Decl(index.js, 12, 5))

/** @class */
foo() {
>foo : Symbol(foo, Decl(index.js, 12, 12))

this.x = 0;
>this : Symbol(b1, Decl(index.js, 12, 10))
>x : Symbol(x, Decl(index.js, 14, 11))
}
}

const b2 = {
>b2 : Symbol(b2, Decl(index.js, 19, 5))

/** @class */
foo: function() {
>foo : Symbol(foo, Decl(index.js, 19, 12))

this.x = 0;
>this.x : Symbol(foo.x, Decl(index.js, 21, 21))
>this : Symbol(foo, Decl(index.js, 21, 8))
>x : Symbol(foo.x, Decl(index.js, 21, 21))
}
}

69 changes: 69 additions & 0 deletions tests/baselines/reference/objectPropertyAsClass.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
=== tests/cases/compiler/index.js ===
const a1 = {
>a1 : { foo(): void; }
>{ foo() { this.x = 0; }} : { foo(): void; }

foo() {
>foo : () => void

this.x = 0;
>this.x = 0 : 0
>this.x : any
>this : { foo(): void; }
>x : any
>0 : 0
}
}

const a2 = {
>a2 : { foo: typeof foo; }
>{ foo: function() { this.x = 0; }} : { foo: typeof foo; }

foo: function() {
>foo : typeof foo
>function() { this.x = 0; } : typeof foo

this.x = 0;
>this.x = 0 : 0
>this.x : any
>this : { foo: typeof foo; }
>x : any
>0 : 0
}
}

const b1 = {
>b1 : { foo(): void; }
>{ /** @class */ foo() { this.x = 0; }} : { foo(): void; }

/** @class */
foo() {
>foo : () => void

this.x = 0;
>this.x = 0 : 0
>this.x : any
>this : { foo(): void; }
>x : any
>0 : 0
}
}

const b2 = {
>b2 : { foo: typeof foo; }
>{ /** @class */ foo: function() { this.x = 0; }} : { foo: typeof foo; }

/** @class */
foo: function() {
>foo : typeof foo
>function() { this.x = 0; } : typeof foo

this.x = 0;
>this.x = 0 : 0
>this.x : any
>this : this
>x : any
>0 : 0
}
}

39 changes: 39 additions & 0 deletions tests/baselines/reference/thisInObjectJs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
//// [index.js]
export { }
let obj = {
x: 10,
y: [1],
fun: function() {
this.x = 1
this/*1*/
},
f2: function() {
this.x
this/*2*/
},
f3: (function() {
this.x = 1
this/*3*/
}),
}


//// [index.js]
"use strict";
exports.__esModule = true;
var obj = {
x: 10,
y: [1],
fun: function () {
this.x = 1;
this; /*1*/
},
f2: function () {
this.x;
this; /*2*/
},
f3: (function () {
this.x = 1;
this; /*3*/
})
};
45 changes: 45 additions & 0 deletions tests/baselines/reference/thisInObjectJs.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
=== tests/cases/compiler/index.js ===
export { }
let obj = {
>obj : Symbol(obj, Decl(index.js, 1, 3))

x: 10,
>x : Symbol(x, Decl(index.js, 1, 11))

y: [1],
>y : Symbol(y, Decl(index.js, 2, 8))

fun: function() {
>fun : Symbol(fun, Decl(index.js, 3, 9))

this.x = 1
>this.x : Symbol(x, Decl(index.js, 1, 11))
>this : Symbol(obj, Decl(index.js, 1, 9))
>x : Symbol(fun.x, Decl(index.js, 4, 19))

this/*1*/
>this : Symbol(obj, Decl(index.js, 1, 9))

},
f2: function() {
>f2 : Symbol(f2, Decl(index.js, 7, 4))

this.x
>this.x : Symbol(x, Decl(index.js, 1, 11))
>this : Symbol(obj, Decl(index.js, 1, 9))
>x : Symbol(x, Decl(index.js, 1, 11))

this/*2*/
>this : Symbol(obj, Decl(index.js, 1, 9))

},
f3: (function() {
>f3 : Symbol(f3, Decl(index.js, 11, 4))

this.x = 1
>x : Symbol((Anonymous function).x, Decl(index.js, 12, 19))

this/*3*/
}),
}

61 changes: 61 additions & 0 deletions tests/baselines/reference/thisInObjectJs.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
=== tests/cases/compiler/index.js ===
export { }
let obj = {
>obj : { x: number; y: number[]; fun: typeof fun; f2: () => void; f3: typeof (Anonymous function); }
>{ x: 10, y: [1], fun: function() { this.x = 1 this/*1*/ }, f2: function() { this.x this/*2*/ }, f3: (function() { this.x = 1 this/*3*/ }),} : { x: number; y: number[]; fun: typeof fun; f2: () => void; f3: typeof (Anonymous function); }

x: 10,
>x : number
>10 : 10

y: [1],
>y : number[]
>[1] : number[]
>1 : 1

fun: function() {
>fun : typeof fun
>function() { this.x = 1 this/*1*/ } : typeof fun

this.x = 1
>this.x = 1 : 1
>this.x : number
>this : { x: number; y: number[]; fun: typeof fun; f2: () => void; f3: typeof (Anonymous function); }
>x : number
>1 : 1

this/*1*/
>this : { x: number; y: number[]; fun: typeof fun; f2: () => void; f3: typeof (Anonymous function); }

},
f2: function() {
>f2 : () => void
>function() { this.x this/*2*/ } : () => void

this.x
>this.x : number
>this : { x: number; y: number[]; fun: typeof fun; f2: () => void; f3: typeof (Anonymous function); }
>x : number

this/*2*/
>this : { x: number; y: number[]; fun: typeof fun; f2: () => void; f3: typeof (Anonymous function); }

},
f3: (function() {
>f3 : typeof (Anonymous function)
>(function() { this.x = 1 this/*3*/ }) : typeof (Anonymous function)
>function() { this.x = 1 this/*3*/ } : typeof (Anonymous function)

this.x = 1
>this.x = 1 : 1
>this.x : any
>this : any
>x : any
>1 : 1

this/*3*/
>this : any

}),
}

30 changes: 30 additions & 0 deletions tests/cases/compiler/objectPropertyAsClass.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// @allowJs: true
// @noEmit: true
// @checkJs: true

// @filename: index.js
const a1 = {
foo() {
this.x = 0;
}
}

const a2 = {
foo: function() {
this.x = 0;
}
}

const b1 = {
/** @class */
foo() {
this.x = 0;
}
}

const b2 = {
/** @class */
foo: function() {
this.x = 0;
}
}
21 changes: 21 additions & 0 deletions tests/cases/compiler/thisInObjectJs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// @allowJs: true
// @outDir: out

// @filename: index.js
export { }
let obj = {
x: 10,
y: [1],
fun: function() {
this.x = 1
this/*1*/
},
f2: function() {
this.x
this/*2*/
},
f3: (function() {
this.x = 1
this/*3*/
}),
}