Skip to content

fix #23589 - stripping internal constructor parameter properties #23615

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
7 changes: 7 additions & 0 deletions src/compiler/transformers/declarations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -966,6 +966,7 @@ namespace ts {
const oldDiag = getSymbolAccessibilityDiagnostic;
parameterProperties = compact(flatMap(ctor.parameters, param => {
if (!hasModifier(param, ModifierFlags.ParameterPropertyModifier)) return;
if (shouldStripInternalParameterProperty(param)) return;
Copy link
Contributor

Choose a reason for hiding this comment

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

why not use shouldStripInternal?

Copy link
Author

Choose a reason for hiding this comment

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

@mhegazy That's what I tried first but to my surprise it did not work; shouldStripInternal returns false!

I found a workaround by scanning the jsDoc elements. But maybe there is fix somewhere else that would make shouldStripInternal return true when the @internal jsdoc comment is present.

Copy link
Contributor

Choose a reason for hiding this comment

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

@weswigham thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

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

looks like #23611 has a fix for that.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, that's a better fix. I'm closing this PR.

getSymbolAccessibilityDiagnostic = createGetSymbolAccessibilityDiagnosticForNode(param);
if (param.name.kind === SyntaxKind.Identifier) {
return preserveJsDoc(createProperty(
Expand Down Expand Up @@ -1150,6 +1151,12 @@ namespace ts {
return false;
}

// shouldStripInternal does not work with constructor parameters. This variant does.
function shouldStripInternalParameterProperty(param: ParameterDeclaration) {
return param.jsDoc && param.jsDoc.some(doc =>
doc.tags.some(tag => getTextOfNode(tag) === "@internal"));
}

function ensureModifiers(node: Node, privateDeclaration?: boolean): ReadonlyArray<Modifier> {
const currentFlags = getModifierFlags(node);
const newFlags = ensureModifierFlags(node, privateDeclaration);
Expand Down
24 changes: 24 additions & 0 deletions tests/baselines/reference/stripInternalParameterProperty.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
//// [stripInternalParameterProperty.ts]
export class C {
constructor(/** @internal */ public foo, public bar) {}
}


//// [stripInternalParameterProperty.js]
"use strict";
exports.__esModule = true;
var C = /** @class */ (function () {
function C(/** @internal */ foo, bar) {
this.foo = foo;
this.bar = bar;
}
return C;
}());
exports.C = C;


//// [stripInternalParameterProperty.d.ts]
export declare class C {
bar: any;
constructor(/** @internal */ foo: any, bar: any);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=== tests/cases/compiler/stripInternalParameterProperty.ts ===
export class C {
>C : Symbol(C, Decl(stripInternalParameterProperty.ts, 0, 0))

constructor(/** @internal */ public foo, public bar) {}
>foo : Symbol(C.foo, Decl(stripInternalParameterProperty.ts, 1, 16))
>bar : Symbol(C.bar, Decl(stripInternalParameterProperty.ts, 1, 44))
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=== tests/cases/compiler/stripInternalParameterProperty.ts ===
export class C {
>C : C

constructor(/** @internal */ public foo, public bar) {}
>foo : any
>bar : any
}

7 changes: 7 additions & 0 deletions tests/cases/compiler/stripInternalParameterProperty.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

// @declaration:true
// @stripInternal:true

export class C {
constructor(/** @internal */ public foo, public bar) {}
}