-
Notifications
You must be signed in to change notification settings - Fork 15.8k
Fix stripInternal handling of unrelated leading comments #64626
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
Open
Максим Иванов (splincode)
wants to merge
2
commits into
microsoft:main
Choose a base branch
from
splincode:fix/strip-internal-unrelated-comments
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
117 changes: 117 additions & 0 deletions
117
tsc/testdata/baselines/reference/compiler/stripInternalUnrelatedComments.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| //// [tests/cases/compiler/stripInternalUnrelatedComments.ts] //// | ||
|
|
||
| //// [unrelated.ts] | ||
| export class Foo { | ||
| /** | ||
| * Should be stripped. | ||
| * @internal | ||
| */ | ||
| shouldBeStripped = 1; | ||
|
|
||
| // TODO: maybe make this @internal? | ||
|
|
||
| /** | ||
| * Public member. | ||
| */ | ||
| shouldNotBeStripped = 2; | ||
|
|
||
| // sure wish I had @internal support! anyway... | ||
| mentionedInLineComment = 3; | ||
|
|
||
| /* TODO: maybe make this @internal? */ | ||
| mentionedInBlockComment = 4; | ||
|
|
||
| /** Public documentation mentioning `@internal`. */ | ||
| mentionedInJSDocText = 5; | ||
|
|
||
| /** @internal */ | ||
| internal = 6; | ||
|
|
||
| public = 7; | ||
|
|
||
| // @internal | ||
| internalLineAnnotation = 8; | ||
|
|
||
| /* @internal */ | ||
| internalBlockAnnotation = 9; | ||
|
|
||
| /** @internal */ | ||
| /** Additional documentation. */ | ||
| internalWithMultipleJSDocComments = 10; | ||
|
|
||
| /** @internalOther */ | ||
| publicWithOtherTag = 11; | ||
|
|
||
| // @internal | ||
| /** Public documentation. */ | ||
| publicAfterUnrelatedAnnotation = 12; | ||
| } | ||
|
|
||
| /** @internal */ | ||
| export const x = 1; | ||
|
|
||
| // TODO: maybe make this @internal? | ||
| /** Public declaration. */ | ||
| export const publicValue = 2; | ||
|
|
||
| export class InternalTypeParameter< | ||
| /** @internal */ T = unknown, | ||
| U = unknown | ||
| > {} | ||
|
|
||
| export class PublicTypeParameters< | ||
| // TODO: maybe make this @internal? | ||
| /** Public type parameter. */ | ||
| T = unknown, | ||
| /** Public documentation mentioning `@internal`. */ | ||
| U = unknown | ||
| > {} | ||
|
|
||
| //// [unrelatedJs.js] | ||
| export class Bar { | ||
| /** @internal */ | ||
| internal = 1; | ||
|
|
||
| // TODO: maybe make this @internal? | ||
| /** Public member. */ | ||
| public = 2; | ||
|
|
||
| // sure wish I had @internal support! anyway... | ||
| mentionedInLineComment = 3; | ||
| } | ||
|
|
||
|
|
||
|
|
||
|
|
||
| //// [unrelated.d.ts] | ||
| export declare class Foo { | ||
| /** | ||
| * Public member. | ||
| */ | ||
| shouldNotBeStripped: number; | ||
| mentionedInLineComment: number; | ||
| mentionedInBlockComment: number; | ||
| /** Public documentation mentioning `@internal`. */ | ||
| mentionedInJSDocText: number; | ||
| public: number; | ||
| /** @internalOther */ | ||
| publicWithOtherTag: number; | ||
| /** Public documentation. */ | ||
| publicAfterUnrelatedAnnotation: number; | ||
| } | ||
| /** Public declaration. */ | ||
| export declare const publicValue = 2; | ||
| export declare class InternalTypeParameter<U = unknown> { | ||
| } | ||
| export declare class PublicTypeParameters< | ||
| /** Public type parameter. */ | ||
| T = unknown, | ||
| /** Public documentation mentioning `@internal`. */ | ||
| U = unknown> { | ||
| } | ||
| //// [unrelatedJs.d.ts] | ||
| export declare class Bar { | ||
| /** Public member. */ | ||
| public: number; | ||
| mentionedInLineComment: number; | ||
| } |
87 changes: 87 additions & 0 deletions
87
tsc/testdata/tests/cases/compiler/stripInternalUnrelatedComments.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // @target: es2015 | ||
| // @declaration: true | ||
| // @emitDeclarationOnly: true | ||
| // @stripInternal: true | ||
| // @allowJs: true | ||
| // @outDir: out | ||
| // @noTypesAndSymbols: true | ||
|
|
||
| // @filename: unrelated.ts | ||
| export class Foo { | ||
| /** | ||
| * Should be stripped. | ||
| * @internal | ||
| */ | ||
| shouldBeStripped = 1; | ||
|
|
||
| // TODO: maybe make this @internal? | ||
|
|
||
| /** | ||
| * Public member. | ||
| */ | ||
| shouldNotBeStripped = 2; | ||
|
|
||
| // sure wish I had @internal support! anyway... | ||
| mentionedInLineComment = 3; | ||
|
|
||
| /* TODO: maybe make this @internal? */ | ||
| mentionedInBlockComment = 4; | ||
|
|
||
| /** Public documentation mentioning `@internal`. */ | ||
| mentionedInJSDocText = 5; | ||
|
|
||
| /** @internal */ | ||
| internal = 6; | ||
|
|
||
| public = 7; | ||
|
|
||
| // @internal | ||
| internalLineAnnotation = 8; | ||
|
|
||
| /* @internal */ | ||
| internalBlockAnnotation = 9; | ||
|
|
||
| /** @internal */ | ||
| /** Additional documentation. */ | ||
| internalWithMultipleJSDocComments = 10; | ||
|
|
||
| /** @internalOther */ | ||
| publicWithOtherTag = 11; | ||
|
|
||
| // @internal | ||
| /** Public documentation. */ | ||
| publicAfterUnrelatedAnnotation = 12; | ||
| } | ||
|
|
||
| /** @internal */ | ||
| export const x = 1; | ||
|
|
||
| // TODO: maybe make this @internal? | ||
| /** Public declaration. */ | ||
| export const publicValue = 2; | ||
|
|
||
| export class InternalTypeParameter< | ||
| /** @internal */ T = unknown, | ||
| U = unknown | ||
| > {} | ||
|
|
||
| export class PublicTypeParameters< | ||
| // TODO: maybe make this @internal? | ||
| /** Public type parameter. */ | ||
| T = unknown, | ||
| /** Public documentation mentioning `@internal`. */ | ||
| U = unknown | ||
| > {} | ||
|
|
||
| // @filename: unrelatedJs.js | ||
| export class Bar { | ||
| /** @internal */ | ||
| internal = 1; | ||
|
|
||
| // TODO: maybe make this @internal? | ||
| /** Public member. */ | ||
| public = 2; | ||
|
|
||
| // sure wish I had @internal support! anyway... | ||
| mentionedInLineComment = 3; | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in 9b38ed2. Type parameters now attach JSDoc during parsing. The regression baseline confirms that the internal T is stripped while the public U remains. Thanks for catching this.