Skip to content

Add legacyAccessorDeclarations flag #34724

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.

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

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions src/compiler/commandLineParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,14 @@ namespace ts {
description: Diagnostics.Only_emit_d_ts_declaration_files,
transpileOptionValue: undefined
},
{
name: "legacyAccessorDeclarations",
type: "boolean",
affectsEmit: true,
category: Diagnostics.Advanced_Options,
description: Diagnostics.Emits_accessors_as_property_declarations_in_declaration_emit,
transpileOptionValue: undefined
},
{
name: "sourceMap",
type: "boolean",
Expand Down
4 changes: 4 additions & 0 deletions src/compiler/diagnosticMessages.json
Original file line number Diff line number Diff line change
Expand Up @@ -4128,6 +4128,10 @@
"category": "Message",
"code": 6223
},
"Emits accessors as property declarations in declaration emit.": {
"category": "Message",
"code": 6224
},

"Projects to reference": {
"category": "Message",
Expand Down
6 changes: 6 additions & 0 deletions src/compiler/program.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3001,6 +3001,12 @@ namespace ts {
}
}

if (options.legacyAccessorDeclarations) {
if (!getEmitDeclarations(options)) {
createDiagnosticForOptionName(Diagnostics.Option_0_cannot_be_specified_without_specifying_option_1_or_option_2, "declarationDir", "declaration", "composite");
}
}

if (options.declarationMap && !getEmitDeclarations(options)) {
createDiagnosticForOptionName(Diagnostics.Option_0_cannot_be_specified_without_specifying_option_1_or_option_2, "declarationMap", "declaration", "composite");
}
Expand Down
7 changes: 5 additions & 2 deletions src/compiler/transformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace ts {
export function getTransformers(compilerOptions: CompilerOptions, customTransformers?: CustomTransformers, emitOnlyDtsFiles?: boolean): EmitTransformers {
return {
scriptTransformers: getScriptTransformers(compilerOptions, customTransformers, emitOnlyDtsFiles),
declarationTransformers: getDeclarationTransformers(customTransformers),
declarationTransformers: getDeclarationTransformers(compilerOptions, customTransformers),
};
}

Expand Down Expand Up @@ -87,9 +87,12 @@ namespace ts {
return transformers;
}

function getDeclarationTransformers(customTransformers?: CustomTransformers) {
function getDeclarationTransformers(compilerOptions: CompilerOptions, customTransformers?: CustomTransformers) {
const transformers: TransformerFactory<SourceFile | Bundle>[] = [];
transformers.push(transformDeclarations);
if (compilerOptions.legacyAccessorDeclarations) {
transformers.push(transformAccessorsToPropertyDeclarations);
}
addRange(transformers, customTransformers && map(customTransformers.afterDeclarations, wrapDeclarationTransformerFactory));
return transformers;
}
Expand Down
65 changes: 65 additions & 0 deletions src/compiler/transformers/legacyAccessorDeclarations.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*@internal*/
namespace ts {
/**
* Transforms accessor declarations in class bodies into roughly equivalent property declarations
*/
export function transformAccessorsToPropertyDeclarations(context: TransformationContext) {
return chainBundle(transformSourceFile);

function transformSourceFile(file: SourceFile) {
return visitEachChild(file, transformNode, context);
}

function transformNode(node: Node): Node {
if (isClassLike(node)) {
if (some(node.members, isAccessor)) {
return visitEachChild(transformClass(node), transformNode, context);
}
}
return visitEachChild(node, transformNode, context);
}

function transformClass(cls: ClassLikeDeclaration): ClassLikeDeclaration {
const members: ClassElement[] = [];
for (const member of cls.members) {
if (!isAccessor(member)) {
members.push(member);
continue;
}
const { firstAccessor, setAccessor } = getAllAccessorDeclarations(cls.members, member);
if (firstAccessor === member) {
members.push(setTextRange(setOriginalNode(createProperty(
member.decorators,
!setAccessor ? createModifiersFromModifierFlags(getModifierFlags(member) | ModifierFlags.Readonly) : member.modifiers,
member.name,
member.questionToken,
isSetAccessor(member) ? getSetAccessorTypeAnnotationNode(member) : getEffectiveReturnTypeNode(member),
/*initializer*/ undefined
), member), member));
}
}

if (isClassDeclaration(cls)) {
return updateClassDeclaration(
cls,
cls.decorators,
cls.modifiers,
cls.name,
cls.typeParameters,
cls.heritageClauses,
members
);
}
else {
return updateClassExpression(
cls,
cls.modifiers,
cls.name,
cls.typeParameters,
cls.heritageClauses,
members
);
}
}
}
}
1 change: 1 addition & 0 deletions src/compiler/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"transformers/module/es2015.ts",
"transformers/declarations/diagnostics.ts",
"transformers/declarations.ts",
"transformers/legacyAccessorDeclarations.ts",
"transformer.ts",
"emitter.ts",
"watchUtilities.ts",
Expand Down
1 change: 1 addition & 0 deletions src/compiler/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4939,6 +4939,7 @@ namespace ts {
declaration?: boolean;
declarationMap?: boolean;
emitDeclarationOnly?: boolean;
legacyAccessorDeclarations?: boolean;
declarationDir?: string;
/* @internal */ diagnostics?: boolean;
/* @internal */ extendedDiagnostics?: boolean;
Expand Down
1 change: 1 addition & 0 deletions tests/baselines/reference/api/tsserverlibrary.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2589,6 +2589,7 @@ declare namespace ts {
declaration?: boolean;
declarationMap?: boolean;
emitDeclarationOnly?: boolean;
legacyAccessorDeclarations?: boolean;
declarationDir?: string;
disableSizeLimit?: boolean;
disableSourceOfProjectReferenceRedirect?: boolean;
Expand Down
1 change: 1 addition & 0 deletions tests/baselines/reference/api/typescript.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2589,6 +2589,7 @@ declare namespace ts {
declaration?: boolean;
declarationMap?: boolean;
emitDeclarationOnly?: boolean;
legacyAccessorDeclarations?: boolean;
declarationDir?: string;
disableSizeLimit?: boolean;
disableSourceOfProjectReferenceRedirect?: boolean;
Expand Down
51 changes: 51 additions & 0 deletions tests/baselines/reference/declarationEmitAccessorsAsProperties.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
//// [declarationEmitAccessorsAsProperties.ts]
export class Cls {
get prop(): number {
return 12;
}

set evt(x: number) {}

get val(): number {
return 42;
}
set val(_) {}
}

//// [declarationEmitAccessorsAsProperties.js]
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var Cls = /** @class */ (function () {
function Cls() {
}
Object.defineProperty(Cls.prototype, "prop", {
get: function () {
return 12;
},
enumerable: true,
configurable: true
});
Object.defineProperty(Cls.prototype, "evt", {
set: function (x) { },
enumerable: true,
configurable: true
});
Object.defineProperty(Cls.prototype, "val", {
get: function () {
return 42;
},
set: function (_) { },
enumerable: true,
configurable: true
});
return Cls;
}());
exports.Cls = Cls;


//// [declarationEmitAccessorsAsProperties.d.ts]
export declare class Cls {
readonly prop: number;
evt: number;
val: number;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
=== tests/cases/compiler/declarationEmitAccessorsAsProperties.ts ===
export class Cls {
>Cls : Symbol(Cls, Decl(declarationEmitAccessorsAsProperties.ts, 0, 0))

get prop(): number {
>prop : Symbol(Cls.prop, Decl(declarationEmitAccessorsAsProperties.ts, 0, 18))

return 12;
}

set evt(x: number) {}
>evt : Symbol(Cls.evt, Decl(declarationEmitAccessorsAsProperties.ts, 3, 5))
>x : Symbol(x, Decl(declarationEmitAccessorsAsProperties.ts, 5, 12))

get val(): number {
>val : Symbol(Cls.val, Decl(declarationEmitAccessorsAsProperties.ts, 5, 25), Decl(declarationEmitAccessorsAsProperties.ts, 9, 5))

return 42;
}
set val(_) {}
>val : Symbol(Cls.val, Decl(declarationEmitAccessorsAsProperties.ts, 5, 25), Decl(declarationEmitAccessorsAsProperties.ts, 9, 5))
>_ : Symbol(_, Decl(declarationEmitAccessorsAsProperties.ts, 10, 12))
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
=== tests/cases/compiler/declarationEmitAccessorsAsProperties.ts ===
export class Cls {
>Cls : Cls

get prop(): number {
>prop : number

return 12;
>12 : 12
}

set evt(x: number) {}
>evt : number
>x : number

get val(): number {
>val : number

return 42;
>42 : 42
}
set val(_) {}
>val : number
>_ : number
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"compilerOptions": {
"legacyAccessorDeclarations": true
}
}
15 changes: 15 additions & 0 deletions tests/cases/compiler/declarationEmitAccessorsAsProperties.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// @declaration: true
// @target: es5
// @legacyAccessorDeclarations: true
export class Cls {
get prop(): number {
return 12;
}

set evt(x: number) {}

get val(): number {
return 42;
}
set val(_) {}
}