feat(core): support usage of non-experimental decorators with TypeScript 5.0 #49492
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
clydin
force-pushed
the
standard-decorators
branch
from
e3a18bf
to
4191dff
Compare
pkozlowski-opensource
added
the
area: core
clydin
force-pushed
the
standard-decorators
branch
2 times, most recently
from
13cdd66
to
e222e90
Compare
clydin
force-pushed
the
standard-decorators
branch
from
e222e90
to
f0a5fca
Compare
clydin
changed the title
clydin
force-pushed
the
standard-decorators
branch
from
f0a5fca
to
2ce2e24
Compare
clydin
force-pushed
the
standard-decorators
branch
3 times, most recently
from
07a6bfc
to
c5e09b1
Compare
clydin
added
the
action: review
clydin
force-pushed
the
standard-decorators
branch
2 times, most recently
from
597c8ef
to
cb3844c
Compare
pullapprove
bot
requested review from
dylhunn,
jessicajaniuk and
pkozlowski-opensource
jessicajaniuk
approved these changes
Apr 3, 2023
alxhub
requested changes
Apr 4, 2023
jelbourn
reviewed
Apr 4, 2023
|
There is a linked CLI E2E test that demonstrates the functionality. If there is a more appropriate place for some tests, i can add them as well. |
clydin
force-pushed
the
standard-decorators
branch
from
cb3844c
to
6bbb68a
Compare
|
@clydin it looks like we the commit message might need an update as well, since the implementation has changed. |
clydin
force-pushed
the
standard-decorators
branch
2 times, most recently
from
6d5d780
to
4069209
Compare
…ipt 5.0 Previously, attempting to turn off the `experimentalDecorators` TypeScript configuration option within an Angular project would result in build time errors. These errors were due to an exposed Decorator signature from `@angular/core` that TypeScript thought was incompatible with standard decorators. However, Angular's class decorators (`Component`, `Directive`, `Pipe`, `Injectable`, `NgModule`) are actually already compatible with standard decorators. The export types for the decorators only needed to be updated to reflect that compatibility. With the updated exported types, applications will now successfully compile and execute in AOT mode with one important dependency injection caveat explained in the note below. For JIT mode applications that are built with the Angular CLI, `@ngtools/webpack`, or use `tsickle`, there were also no additional changes required. These tools automatically convert property decorators (now called field decorators) at build time to store Angular property metadata directly on the relevant class. Building with these tools is the overwhelmingly common method of building an application. Any applications that do not use one of these tools will not function at runtime in JIT mode if using standard decorators. The behavior and code for when experimental decorators is enabled has been left intact. NOTE: Angular constructor dependency injection that requires parameter decorators is not supported. The standard decorator specification does not support parameter decorators. The `inject` function must be used for all cases that previously required a parameter decorator. This includes such decorators as `Inject`, `Optional`, `Self`, `SkipSelf`, `Host`, and `Attribute`. Constructor dependency injection that relies only on the supplied parameter type will continue to function as expected if using AOT; as well as in JIT mode if using the Angular CLI, `@ngtools/webpack` directly, or `tsickle`. Documentation for the `inject` function can be found at: https://angular.io/api/core/inject The decorator specification proposal can be found at: https://github.com/tc39/proposal-decorators
clydin
force-pushed
the
standard-decorators
branch
from
4069209
to
16468ff
Compare
|
PR has been updated to throw instead and now contains much less code. |
|
@clydin Is this still targeted for v16? Just checking in, since freeze is today. Happy to push on it or contributed in any way you need. |
alxhub
approved these changes
Apr 5, 2023
dylhunn
added
action: merge
|
This PR was merged into the repository by commit aad05eb. |
|
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. |
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Previously, attempting to turn off the
experimentalDecoratorsTypeScript configuration option within an Angular project would result in build time errors. These errors were due to an exposed Decorator signature from@angular/corethat TypeScript thought was incompatible with standard decorators. However, Angular's class decorators (Component,Directive,Pipe,Injectable,NgModule) are actually already compatible with standard decorators. The export types for the decorators only needed to be updated to reflect that compatibility. With the updated exported types, applications will now successfully compile and execute in AOT mode with one important dependency injection caveat explained in the note below.For JIT mode applications that are built with the Angular CLI,
@ngtools/webpack, or usetsickle, there were also no additional changes required with the same dependency injection caveat. These tools automatically convert property decorators (now called field decorators) at build time to store Angular property metadata directly on the relevant class. Building with these tools is the overwhelmingly common method of building an application. Any applications that do not use one of these tools will not function at runtime in JIT mode if using standard decorators. The behavior and code for when experimental decorators is enabled has been left intact.NOTE: Angular constructor dependency injection that requires parameter decorators is not supported. The standard decorator specification does not support parameter decorators. The
injectfunction must be used for all cases that previously required a parameter decorator. This includes such decorators asInject,Optional,Self,SkipSelf,Host, andAttribute. Constructor dependency injection that relies only on the supplied parameter type will continue to function as expected if using AOT; as well as in JIT mode if using the Angular CLI,@ngtools/webpackdirectly, ortsickle.Does this PR introduce a breaking change?
Other information
Documentation for the
injectfunction can be found at: https://angular.io/api/core/injectThe decorator specification proposal can be found at: https://github.com/tc39/proposal-decorators
An initial CLI E2E test that uses these changes is available here: angular/angular-cli#24886