fix(compiler-cli): avoid broken references in .d.ts files due to @internal markers #43527
Conversation
This file contains 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
JoostK
added
area: packaging
JoostK
force-pushed
the
ngtsc/dts-errors
branch
from
c816d10
to
c1f301f
Compare
JoostK
added
the
action: review
atscott
approved these changes
Sep 23, 2021
JoostK
added
action: merge
|
any progress on this ? |
JoostK
force-pushed
the
ngtsc/dts-errors
branch
from
c1f301f
to
e41c9a8
Compare
|
@huineng This introduces a conflict when syncing into Google and we're currently pushing towards getting v13 finalized, so this got stalled. |
JoostK
added
action: cleanup
JoostK
force-pushed
the
ngtsc/dts-errors
branch
from
e41c9a8
to
882cb19
Compare
JoostK
force-pushed
the
ngtsc/dts-errors
branch
from
882cb19
to
9dfac0d
Compare
…ernal markers The `ErrorCode` enum in the `error_code.ts` file is governed by public api guards but the other top-level exports from that file are exempt from public api documentation and are therefore marked as `@internal`. However, TypeScript is configured with the `stripInternal` compiler option such that declarations with `@internal` markers are not emitted into the `.d.ts` files, but this means that the reexports in the barrel file end up referring to missing declarations. The `stripInternal` option is considered internal and its documentation states to use at your own risk (as per microsoft/TypeScript#45307). Having the option enabled is desirable for us as it works well for hiding class fields that are marked `@internal`, which is an effective way to hide members from the .d.ts file. As a workaround for the issue with top-level symbols, the declarations with `@internal` markers are moved to dedicated files for which no public api guard is setup, therefore allowing their `@internal` markers to be dropped. Fixes angular#43097
…arate file Prior refactorings caused unexpected g3 sync issues due to a patch that changes the error documentation URL. This commit moves the base url into a separate file to make this more apparent.
…nto separate file
JoostK
force-pushed
the
ngtsc/dts-errors
branch
from
9dfac0d
to
3d82d56
Compare
AndrewKushnir
added
action: presubmit
AndrewKushnir
added
action: merge
|
Note to the Caretaker: syncing this PR would require extra steps. Please reach out to @AndrewKushnir to get more info. |
|
This PR was merged into the repository by commit 28a40f3. |
jessicajaniuk
pushed a commit
that referenced
this pull request
Oct 26, 2021
…ernal markers (#43527) The `ErrorCode` enum in the `error_code.ts` file is governed by public api guards but the other top-level exports from that file are exempt from public api documentation and are therefore marked as `@internal`. However, TypeScript is configured with the `stripInternal` compiler option such that declarations with `@internal` markers are not emitted into the `.d.ts` files, but this means that the reexports in the barrel file end up referring to missing declarations. The `stripInternal` option is considered internal and its documentation states to use at your own risk (as per microsoft/TypeScript#45307). Having the option enabled is desirable for us as it works well for hiding class fields that are marked `@internal`, which is an effective way to hide members from the .d.ts file. As a workaround for the issue with top-level symbols, the declarations with `@internal` markers are moved to dedicated files for which no public api guard is setup, therefore allowing their `@internal` markers to be dropped. Fixes #43097 PR Close #43527
jessicajaniuk
pushed a commit
that referenced
this pull request
Oct 26, 2021
…ernal markers (#43527) The `ErrorCode` enum in the `error_code.ts` file is governed by public api guards but the other top-level exports from that file are exempt from public api documentation and are therefore marked as `@internal`. However, TypeScript is configured with the `stripInternal` compiler option such that declarations with `@internal` markers are not emitted into the `.d.ts` files, but this means that the reexports in the barrel file end up referring to missing declarations. The `stripInternal` option is considered internal and its documentation states to use at your own risk (as per microsoft/TypeScript#45307). Having the option enabled is desirable for us as it works well for hiding class fields that are marked `@internal`, which is an effective way to hide members from the .d.ts file. As a workaround for the issue with top-level symbols, the declarations with `@internal` markers are moved to dedicated files for which no public api guard is setup, therefore allowing their `@internal` markers to be dropped. Fixes #43097 PR Close #43527
jessicajaniuk
pushed a commit
to jessicajaniuk/angular
that referenced
this pull request
Oct 26, 2021
…into separate file (angular#43527)" This reverts commit 28a40f3.
Closed
This was referenced Nov 1, 2021
build(deps-dev): bump @angular/compiler-cli from 12.2.4 to 12.2.12
numbersprotocol/capture-lite#1018
Closed
Closed
build(deps): bump @angular/platform-browser from 12.2.4 to 12.2.12
numbersprotocol/capture-lite#1003
Closed
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Serginho
pushed a commit
to TuLotero/angular
that referenced
this pull request
Jan 20, 2022
…ernal markers (angular#43527) The `ErrorCode` enum in the `error_code.ts` file is governed by public api guards but the other top-level exports from that file are exempt from public api documentation and are therefore marked as `@internal`. However, TypeScript is configured with the `stripInternal` compiler option such that declarations with `@internal` markers are not emitted into the `.d.ts` files, but this means that the reexports in the barrel file end up referring to missing declarations. The `stripInternal` option is considered internal and its documentation states to use at your own risk (as per microsoft/TypeScript#45307). Having the option enabled is desirable for us as it works well for hiding class fields that are marked `@internal`, which is an effective way to hide members from the .d.ts file. As a workaround for the issue with top-level symbols, the declarations with `@internal` markers are moved to dedicated files for which no public api guard is setup, therefore allowing their `@internal` markers to be dropped. Fixes angular#43097 PR Close angular#43527
Serginho
pushed a commit
to TuLotero/angular
that referenced
this pull request
Jan 20, 2022
…arate file (angular#43527) Prior refactorings caused unexpected g3 sync issues due to a patch that changes the error documentation URL. This commit moves the base url into a separate file to make this more apparent. PR Close angular#43527
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The
ErrorCodeenum in theerror_code.tsfile is governed by publicapi guards but the other top-level exports from that file are exempt
from public api documentation and are therefore marked as
@internal.However, TypeScript is configured with the
stripInternalcompileroption such that declarations with
@internalmarkers are not emittedinto the
.d.tsfiles, but this means that the reexports in the barrelfile end up referring to missing declarations.
The
stripInternaloption is considered internal and its documentationstates to use at your own risk (as per microsoft/TypeScript#45307).
Having the option enabled is desirable for us as it works well for
hiding class fields that are marked
@internal, which is an effectiveway to hide members from the .d.ts file. As a workaround for the issue
with top-level symbols, the declarations with
@internalmarkers aremoved to dedicated files for which no public api guard is setup,
therefore allowing their
@internalmarkers to be dropped.Fixes #43097