Refactor node factory API, use node factory in parser #35282
Merged
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
|
@typescript-bot perf test |
|
Heya @rbuckton, I've started to run the perf test suite on this PR at 922ab41. You can monitor the build here. It should now contribute to this PR's status checks. Update: The results are in! |
weswigham
reviewed
Nov 22, 2019
...baselines/reference/JSDocParsing/DocComments.parsesCorrectly.typedefTagWithChildrenTags.json
Show resolved
Hide resolved
|
@rbuckton Here they are:Comparison Report - master..35282
System
Hosts
Scenarios
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
@typescript-bot perf test |
|
Heya @rbuckton, I've started to run the perf test suite on this PR at ae7c638. You can monitor the build here. It should now contribute to this PR's status checks. Update: The results are in! |
|
@rbuckton Here they are:Comparison Report - master..35282
System
Hosts
Scenarios
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
What's the benefit of having to use |
This was referenced May 7, 2020
Merged
The current factory methods mark nodes as For example, the parser now utilizes a custom TypeScript/src/compiler/parser.ts Lines 695 to 716 in 086633f The existing factory methods will still be available for some period of time with deprecations: https://github.com/microsoft/TypeScript/blob/086633f4db521efb6bc25aadaca68f457e56a95b/src/compat/deprecations.ts. This model allows us to introduce deprecations with different levels of aggressiveness:
|
|
@typescript-bot perf test |
# Conflicts: # src/compiler/factoryPublic.ts # src/services/codefixes/convertToAsyncFunction.ts # src/services/codefixes/helpers.ts # src/services/codefixes/inferFromUsage.ts # src/services/signatureHelp.ts # tests/baselines/reference/api/tsserverlibrary.d.ts # tests/baselines/reference/api/typescript.d.ts
# Conflicts: # src/compiler/binder.ts # src/compiler/checker.ts # src/compiler/factory.ts # src/compiler/transformers/declarations.ts # src/compiler/transformers/es2015.ts # src/compiler/transformers/module/module.ts # src/compiler/transformers/module/system.ts # src/compiler/transformers/taggedTemplate.ts # src/compiler/transformers/ts.ts # src/compiler/utilities.ts # src/compiler/visitor.ts # src/harness/vfsUtil.ts # src/services/codefixes/addMissingAsync.ts # src/services/codefixes/convertToMappedObjectType.ts # src/services/codefixes/helpers.ts # src/services/completions.ts # src/services/refactors/generateGetAccessorAndSetAccessor.ts
# Conflicts: # src/compiler/transformers/es2015.ts # src/compiler/transformers/module/system.ts
RyanCavanaugh
approved these changes
Jun 16, 2020
|
I'm going to merge master into this one more time to make sure there aren't any new changes that need to be captured, then I can merge this to master. |
|
Nice work! Was a decision made on the renaming proposal? |
|
Yes, we merged #39058 which used the more consistent and clearer names for factory methods. |
5 tasks
1 task
2 tasks
edsrzf
added a commit
to edsrzf/ts-migrate
that referenced
this pull request
Oct 24, 2020
Most ts.create* and ts.update* functions are deprecated as of TypeScript 4.0. The current plan is to emit noiser and noisier warnings with each version until the deprecated functions are removed in 4.3. See this pull request for more details: microsoft/TypeScript#35282 Some method signatures and names have changed slightly. The easy way to update is to use the global ts.factory object. TypeScript transformations also have access to a NodeFactory in their transformation contexts. Note that we still use the deprecate getMutableClone function because its replacement is not included in the TypeScript declarations. See microsoft/TypeScript#40507
jasonreyes9
added a commit
to jasonreyes9/ts-migrate
that referenced
this pull request
Oct 31, 2023
Most ts.create* and ts.update* functions are deprecated as of TypeScript 4.0. The current plan is to emit noiser and noisier warnings with each version until the deprecated functions are removed in 4.3. See this pull request for more details: microsoft/TypeScript#35282 Some method signatures and names have changed slightly. The easy way to update is to use the global ts.factory object. TypeScript transformations also have access to a NodeFactory in their transformation contexts. Note that we still use the deprecate getMutableClone function because its replacement is not included in the TypeScript declarations. See microsoft/TypeScript#40507
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This overhauls our node factory API to provide the following benefits:
Nodeis stable between the parser, checker, and transformers to reduce polymorphism, as well as to provide a "single source of truth" with respect to how nodes are created.binder.tsandtransformer.tsand ensures that transform flags will always be correctly aggregated during transformations.In the future, this will also allow us to better isolate which transformer was responsible for creating nodes, as well as to possibly leverage transformers outside of the emit pipeline.
As part of these changes, all of the existing
create*andupdate*factory functions in thetsnamespace are being moved to aNodeFactoryobject that can be created via the internalcreateNodeFactoryfunction. Authors of transformers can access theNodeFactoryassociated with their transformation via theTransformationContextprovided to their transformer:In addition, the
ts.factoryobject is a singletonNodeFactoryinstance, which can be used to create synthetic nodes outside of a transformer.So as not to break compatibility with older API consumers, the existing
create*andupdate*factory functions will also be available to consumers of the TypeScript language service and the TS Server API. However, these functions are considered deprecated, and will be phased out using the following (tentative) plan:@deprecatedJSDoc comment and are no longer used by TypeScript internals.console.log-like logger is available).Remaining TODO items:
createParento a more expressive (and less ambiguous) name such ascreateParenthesizedExpression.readonly, as one goal is to treat a TypeScript AST as immutable (and should be "changed" via visitors).