Skip to content

Set implied node format during source file creation #637

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

Merged
merged 35 commits into from
Mar 19, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
66f4788
Set implied node format during source file creation
frodi-karlsson Mar 16, 2025
48873eb
Merge branch 'main' into implied-node-format-setting
frodi-karlsson Mar 16, 2025
fb0f304
Move into file loader
frodi-karlsson Mar 16, 2025
3e7b92c
Merge branch 'implied-node-format-setting' of github.com:frodi-karlss…
frodi-karlsson Mar 16, 2025
8bba782
Revert back to main to start from scratch with storing on Program per…
frodi-karlsson Mar 16, 2025
d1f5959
Try a v3 with parser-set fields, keep hacking at it
frodi-karlsson Mar 17, 2025
e5645d2
Merge branch 'main' into implied-node-format-setting
frodi-karlsson Mar 17, 2025
e825898
Resolve bad history linearly
frodi-karlsson Mar 17, 2025
1f3b470
Fix languageservice <-> project dependency muck up
frodi-karlsson Mar 17, 2025
1a66c19
Pass around package json type instead of cache entry
frodi-karlsson Mar 17, 2025
0112b00
Remove left-over !!!
frodi-karlsson Mar 17, 2025
8366e88
Remove GetImpliedNodeFormat
frodi-karlsson Mar 17, 2025
d33133b
Remove harnessUtil package json garbage
frodi-karlsson Mar 17, 2025
b81a9d1
Remove unnecessary newline
frodi-karlsson Mar 17, 2025
406918a
Move off of AST into a map in program
frodi-karlsson Mar 17, 2025
44d6aff
Move creation of metadata into fileloader
frodi-karlsson Mar 17, 2025
54fc786
Change arg to fileName and remove packageType argument in caching method
frodi-karlsson Mar 17, 2025
0644fd3
Appease linter and remove unnecessary convert
frodi-karlsson Mar 17, 2025
8d1f096
Use extension constants
frodi-karlsson Mar 18, 2025
344710a
Merge branch 'main' into implied-node-format-setting (-X theirs for
frodi-karlsson Mar 18, 2025
f6fcb49
Pass single sourceFileMetaData from program into emitContext
frodi-karlsson Mar 18, 2025
a1d63f5
Merge branch 'main' into implied-node-format-setting
frodi-karlsson Mar 18, 2025
3c902b8
Accept insane new diff wins
frodi-karlsson Mar 18, 2025
08333cf
Switch back to map
frodi-karlsson Mar 18, 2025
ba527ba
Use path as map key
frodi-karlsson Mar 18, 2025
4f740f1
Revert walking originals
frodi-karlsson Mar 18, 2025
d1e2b2e
Create MetaDataProvider
frodi-karlsson Mar 18, 2025
7da5ddc
Move commonjs metadata provider adding to struct declaration
frodi-karlsson Mar 18, 2025
e2c7a77
Use program as SourceFileMetaDataProvider and share fakeProgram in te…
frodi-karlsson Mar 18, 2025
3099425
Revert moving to util and create smaller fakeSourceFileMetaDataProvider
frodi-karlsson Mar 18, 2025
1697b75
Realign naming to provider
frodi-karlsson Mar 18, 2025
d86780d
Remove unnecessary struct
frodi-karlsson Mar 18, 2025
ac71490
Fix henceforth "load"SourceFileMetaData, spacings and leftover
frodi-karlsson Mar 18, 2025
286beed
Switch to RWMutex and include map creation in w lock
frodi-karlsson Mar 19, 2025
ed015b3
Fix deadlock
frodi-karlsson Mar 19, 2025
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
15 changes: 9 additions & 6 deletions internal/compiler/emitter.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ func (e *emitter) emit() {
e.emitBuildInfo(e.paths.buildInfoPath)
}

func (e *emitter) getModuleTransformer(emitContext *printer.EmitContext, resolver binder.ReferenceResolver) *transformers.Transformer {
func (e *emitter) getModuleTransformer(emitContext *printer.EmitContext, resolver binder.ReferenceResolver, metaDataProvider transformers.MetaDataProvider) *transformers.Transformer {
options := e.host.Options()

switch options.GetEmitModuleKind() {
case core.ModuleKindPreserve:
// `ESModuleTransformer` contains logic for preserving CJS input syntax in `--module preserve`
return transformers.NewESModuleTransformer(emitContext, options, resolver)
return transformers.NewESModuleTransformer(emitContext, options, resolver, metaDataProvider)

case core.ModuleKindESNext,
core.ModuleKindES2022,
Expand All @@ -53,10 +53,10 @@ func (e *emitter) getModuleTransformer(emitContext *printer.EmitContext, resolve
core.ModuleKindNode16,
core.ModuleKindNodeNext,
core.ModuleKindCommonJS:
return transformers.NewImpliedModuleTransformer(emitContext, options, resolver)
return transformers.NewImpliedModuleTransformer(emitContext, options, resolver, metaDataProvider)

default:
return transformers.NewCommonJSModuleTransformer(emitContext, options, resolver)
return transformers.NewCommonJSModuleTransformer(emitContext, options, resolver, metaDataProvider)
}
}

Expand All @@ -77,6 +77,10 @@ func (e *emitter) getScriptTransformers(emitContext *printer.EmitContext, source
referenceResolver = binder.NewReferenceResolver(options, binder.ReferenceResolverHooks{})
}

metaDataProvider := transformers.NewMetaDataProvider(func(file *ast.SourceFile) *ast.SourceFileMetaData {
return e.host.GetCachedSourceFileMetaDatas()[file.Path()]
})

// erase types
tx = append(tx, transformers.NewTypeEraserTransformer(emitContext, options))

Expand All @@ -89,7 +93,7 @@ func (e *emitter) getScriptTransformers(emitContext *printer.EmitContext, source
tx = append(tx, transformers.NewRuntimeSyntaxTransformer(emitContext, options, referenceResolver))

// transform module syntax
tx = append(tx, e.getModuleTransformer(emitContext, referenceResolver))
tx = append(tx, e.getModuleTransformer(emitContext, referenceResolver, metaDataProvider))
return tx
}

Expand All @@ -105,7 +109,6 @@ func (e *emitter) emitJsFile(sourceFile *ast.SourceFile, jsFilePath string, sour
}

emitContext := printer.NewEmitContext()
emitContext.SetSourcefileMetaDatas(e.host.GetCachedSourceFileMetaDatas())
for _, transformer := range e.getScriptTransformers(emitContext, sourceFile) {
sourceFile = transformer.TransformSourceFile(sourceFile)
}
Expand Down
26 changes: 8 additions & 18 deletions internal/printer/emitcontext.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,20 @@ import (
"github.com/microsoft/typescript-go/internal/ast"
"github.com/microsoft/typescript-go/internal/collections"
"github.com/microsoft/typescript-go/internal/core"
"github.com/microsoft/typescript-go/internal/tspath"
)

// Stores side-table information used during transformation that can be read by the printer to customize emit
//
// NOTE: EmitContext is not guaranteed to be thread-safe.
type EmitContext struct {
Factory *ast.NodeFactory // Required. The NodeFactory to use to create new nodes
autoGenerate map[*ast.MemberName]*AutoGenerateInfo
textSource map[*ast.StringLiteralNode]*ast.Node
original map[*ast.Node]*ast.Node
emitNodes core.LinkStore[*ast.Node, emitNode]
varScopeStack core.Stack[*varScope]
letScopeStack core.Stack[*varScope]
emitHelpers collections.OrderedSet[*EmitHelper]
sourceFileMetaDatas map[tspath.Path]*ast.SourceFileMetaData
Factory *ast.NodeFactory // Required. The NodeFactory to use to create new nodes
autoGenerate map[*ast.MemberName]*AutoGenerateInfo
textSource map[*ast.StringLiteralNode]*ast.Node
original map[*ast.Node]*ast.Node
emitNodes core.LinkStore[*ast.Node, emitNode]
varScopeStack core.Stack[*varScope]
letScopeStack core.Stack[*varScope]
emitHelpers collections.OrderedSet[*EmitHelper]

isCustomPrologue func(node *ast.Statement) bool
isHoistedFunction func(node *ast.Statement) bool
Expand Down Expand Up @@ -627,10 +625,6 @@ func (c *EmitContext) NewRewriteRelativeImportExtensionsHelper(firstArgument *as
)
}

func (c *EmitContext) SetSourcefileMetaDatas(sourceFileMetaDatas map[tspath.Path]*ast.SourceFileMetaData) {
c.sourceFileMetaDatas = sourceFileMetaDatas
}

//
// Original Node Tracking
//
Expand Down Expand Up @@ -955,7 +949,3 @@ func (c *EmitContext) VisitIterationBody(body *ast.Statement, visitor *ast.NodeV

return updated
}

func (c *EmitContext) GetSourceFileMetaData(file *ast.SourceFile) *ast.SourceFileMetaData {
return c.sourceFileMetaDatas[file.Path()]
}
8 changes: 5 additions & 3 deletions internal/transformers/commonjsmodule.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ type CommonJSModuleTransformer struct {
assignmentPatternVisitor *ast.NodeVisitor // visits assignment patterns in a destructuring assignment
compilerOptions *core.CompilerOptions
resolver binder.ReferenceResolver
metaDataProvider MetaDataProvider
moduleKind core.ModuleKind
languageVersion core.ScriptTarget
currentSourceFile *ast.SourceFile
Expand All @@ -26,7 +27,7 @@ type CommonJSModuleTransformer struct {
currentNode *ast.Node // used for ancestor tracking via pushNode/popNode to detect expression identifiers
}

func NewCommonJSModuleTransformer(emitContext *printer.EmitContext, compilerOptions *core.CompilerOptions, resolver binder.ReferenceResolver) *Transformer {
func NewCommonJSModuleTransformer(emitContext *printer.EmitContext, compilerOptions *core.CompilerOptions, resolver binder.ReferenceResolver, metaDataProvider MetaDataProvider) *Transformer {
if resolver == nil {
resolver = binder.NewReferenceResolver(compilerOptions, binder.ReferenceResolverHooks{})
}
Expand All @@ -37,6 +38,7 @@ func NewCommonJSModuleTransformer(emitContext *printer.EmitContext, compilerOpti
tx.assignmentPatternVisitor = emitContext.NewNodeVisitor(tx.visitAssignmentPattern)
tx.languageVersion = compilerOptions.GetEmitScriptTarget()
tx.moduleKind = compilerOptions.GetEmitModuleKind()
tx.metaDataProvider = metaDataProvider
return tx.newTransformer(tx.visit, emitContext)
}

Expand Down Expand Up @@ -362,7 +364,7 @@ func (tx *CommonJSModuleTransformer) transformCommonJSModule(node *ast.SourceFil
result := tx.factory.UpdateSourceFile(node, statementList).AsSourceFile()
tx.emitContext.AddEmitHelper(result.AsNode(), tx.emitContext.ReadEmitHelpers()...)

externalHelpersImportDeclaration := createExternalHelpersImportDeclarationIfNeeded(tx.emitContext, result, tx.compilerOptions, false /*hasExportStarsToExportValues*/, false /*hasImportStar*/, false /*hasImportDefault*/)
externalHelpersImportDeclaration := createExternalHelpersImportDeclarationIfNeeded(tx.emitContext, result, tx.compilerOptions, tx.metaDataProvider, false /*hasExportStarsToExportValues*/, false /*hasImportStar*/, false /*hasImportDefault*/)
if externalHelpersImportDeclaration != nil {
prologue, rest := tx.emitContext.SplitStandardPrologue(result.Statements.Nodes)
custom, rest := tx.emitContext.SplitCustomPrologue(rest)
Expand Down Expand Up @@ -1680,7 +1682,7 @@ func (tx *CommonJSModuleTransformer) visitCallExpression(node *ast.CallExpressio

func (tx *CommonJSModuleTransformer) shouldTransformImportCall() bool {
// !!! host.shouldTransformImportCall?
return shouldTransformImportCallWorker(tx.currentSourceFile, tx.compilerOptions, tx.emitContext.GetSourceFileMetaData(tx.currentSourceFile))
return shouldTransformImportCallWorker(tx.currentSourceFile, tx.compilerOptions, tx.metaDataProvider.GetSourceFileMetaData(tx.currentSourceFile))
}

func (tx *CommonJSModuleTransformer) visitImportCallExpression(node *ast.CallExpression, rewriteOrShim bool) *ast.Node {
Expand Down
5 changes: 4 additions & 1 deletion internal/transformers/commonjsmodule_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1027,8 +1027,11 @@ exports.a = a;`,

emitContext := printer.NewEmitContext()
resolver := binder.NewReferenceResolver(&compilerOptions, binder.ReferenceResolverHooks{})
metaDataProvider := NewMetaDataProvider(func(file *ast.SourceFile) *ast.SourceFileMetaData {
return nil
})
file = NewRuntimeSyntaxTransformer(emitContext, &compilerOptions, resolver).TransformSourceFile(file)
file = NewCommonJSModuleTransformer(emitContext, &compilerOptions, resolver).TransformSourceFile(file)
file = NewCommonJSModuleTransformer(emitContext, &compilerOptions, resolver, metaDataProvider).TransformSourceFile(file)
emittestutil.CheckEmit(t, emitContext, file, rec.output)
})
}
Expand Down
7 changes: 4 additions & 3 deletions internal/transformers/esmodule.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ type ESModuleTransformer struct {
Transformer
compilerOptions *core.CompilerOptions
resolver binder.ReferenceResolver
metaDataProvider MetaDataProvider
currentSourceFile *ast.SourceFile
importRequireStatements *importRequireStatements
helperNameSubstitutions map[string]*ast.IdentifierNode
Expand All @@ -23,11 +24,11 @@ type importRequireStatements struct {
requireHelperName *ast.IdentifierNode
}

func NewESModuleTransformer(emitContext *printer.EmitContext, compilerOptions *core.CompilerOptions, resolver binder.ReferenceResolver) *Transformer {
func NewESModuleTransformer(emitContext *printer.EmitContext, compilerOptions *core.CompilerOptions, resolver binder.ReferenceResolver, metaDataProvider MetaDataProvider) *Transformer {
if resolver == nil {
resolver = binder.NewReferenceResolver(compilerOptions, binder.ReferenceResolverHooks{})
}
tx := &ESModuleTransformer{compilerOptions: compilerOptions, resolver: resolver}
tx := &ESModuleTransformer{compilerOptions: compilerOptions, resolver: resolver, metaDataProvider: metaDataProvider}
return tx.newTransformer(tx.visit, emitContext)
}

Expand Down Expand Up @@ -64,7 +65,7 @@ func (tx *ESModuleTransformer) visitSourceFile(node *ast.SourceFile) *ast.Node {
result := tx.visitor.VisitEachChild(node.AsNode()).AsSourceFile()
tx.emitContext.AddEmitHelper(result.AsNode(), tx.emitContext.ReadEmitHelpers()...)

externalHelpersImportDeclaration := createExternalHelpersImportDeclarationIfNeeded(tx.emitContext, result, tx.compilerOptions, false /*hasExportStarsToExportValues*/, false /*hasImportStar*/, false /*hasImportDefault*/)
externalHelpersImportDeclaration := createExternalHelpersImportDeclarationIfNeeded(tx.emitContext, result, tx.compilerOptions, tx.metaDataProvider, false /*hasExportStarsToExportValues*/, false /*hasImportStar*/, false /*hasImportDefault*/)
if externalHelpersImportDeclaration != nil || tx.importRequireStatements != nil {
prologue, rest := tx.emitContext.SplitStandardPrologue(result.Statements.Nodes)
statements := slices.Clone(prologue)
Expand Down
5 changes: 4 additions & 1 deletion internal/transformers/esmodule_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,11 @@ var __rewriteRelativeImportExtension;`,

emitContext := printer.NewEmitContext()
resolver := binder.NewReferenceResolver(&compilerOptions, binder.ReferenceResolverHooks{})
metaDataProvider := NewMetaDataProvider(func(file *ast.SourceFile) *ast.SourceFileMetaData {
return nil
})
file = NewRuntimeSyntaxTransformer(emitContext, &compilerOptions, resolver).TransformSourceFile(file)
file = NewESModuleTransformer(emitContext, &compilerOptions, resolver).TransformSourceFile(file)
file = NewESModuleTransformer(emitContext, &compilerOptions, resolver, metaDataProvider).TransformSourceFile(file)
emittestutil.CheckEmit(t, emitContext, file, rec.output)
})
}
Expand Down
6 changes: 3 additions & 3 deletions internal/transformers/externalmoduleinfo.go
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,10 @@ func (c *externalModuleInfoCollector) collectExportedVariableInfo(decl *ast.Node

const externalHelpersModuleNameText = "tslib"

func createExternalHelpersImportDeclarationIfNeeded(emitContext *printer.EmitContext, sourceFile *ast.SourceFile, compilerOptions *core.CompilerOptions, hasExportStarsToExportValues bool, hasImportStar bool, hasImportDefault bool) *ast.Node /*ImportDeclaration | ImportEqualsDeclaration*/ {
func createExternalHelpersImportDeclarationIfNeeded(emitContext *printer.EmitContext, sourceFile *ast.SourceFile, compilerOptions *core.CompilerOptions, metaDataProvider MetaDataProvider, hasExportStarsToExportValues bool, hasImportStar bool, hasImportDefault bool) *ast.Node /*ImportDeclaration | ImportEqualsDeclaration*/ {
if compilerOptions.ImportHelpers.IsTrue() && ast.IsEffectiveExternalModule(sourceFile, compilerOptions) {
moduleKind := compilerOptions.GetEmitModuleKind()
impliedModuleKind := ast.GetImpliedNodeFormatForEmitWorker(sourceFile.FileName(), compilerOptions, emitContext.GetSourceFileMetaData(sourceFile))
impliedModuleKind := ast.GetImpliedNodeFormatForEmitWorker(sourceFile.FileName(), compilerOptions, metaDataProvider.GetSourceFileMetaData(sourceFile))
helpers := getImportedHelpers(emitContext, sourceFile)
if (moduleKind >= core.ModuleKindES2015 && moduleKind <= core.ModuleKindESNext) ||
impliedModuleKind == core.ModuleKindESNext ||
Expand Down Expand Up @@ -291,7 +291,7 @@ func createExternalHelpersImportDeclarationIfNeeded(emitContext *printer.EmitCon
}
} else {
// When we emit to a non-ES module, generate a synthetic `import tslib = require("tslib")` to be further transformed.
externalHelpersModuleName := getOrCreateExternalHelpersModuleNameIfNeeded(emitContext, sourceFile, compilerOptions, helpers, hasExportStarsToExportValues, hasImportStar || hasImportDefault, emitContext.GetSourceFileMetaData(sourceFile))
externalHelpersModuleName := getOrCreateExternalHelpersModuleNameIfNeeded(emitContext, sourceFile, compilerOptions, helpers, hasExportStarsToExportValues, hasImportStar || hasImportDefault, metaDataProvider.GetSourceFileMetaData(sourceFile))
if externalHelpersModuleName != nil {
externalHelpersImportDeclaration := emitContext.Factory.NewImportEqualsDeclaration(
nil, /*modifiers*/
Expand Down
19 changes: 10 additions & 9 deletions internal/transformers/impliedmodule.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,18 @@ import (

type ImpliedModuleTransformer struct {
Transformer
compilerOptions *core.CompilerOptions
resolver binder.ReferenceResolver
cjsTransformer *Transformer
esmTransformer *Transformer
compilerOptions *core.CompilerOptions
resolver binder.ReferenceResolver
metaDataProvider MetaDataProvider
cjsTransformer *Transformer
esmTransformer *Transformer
}

func NewImpliedModuleTransformer(emitContext *printer.EmitContext, compilerOptions *core.CompilerOptions, resolver binder.ReferenceResolver) *Transformer {
func NewImpliedModuleTransformer(emitContext *printer.EmitContext, compilerOptions *core.CompilerOptions, resolver binder.ReferenceResolver, metaDataProvider MetaDataProvider) *Transformer {
if resolver == nil {
resolver = binder.NewReferenceResolver(compilerOptions, binder.ReferenceResolverHooks{})
}
tx := &ImpliedModuleTransformer{compilerOptions: compilerOptions, resolver: resolver}
tx := &ImpliedModuleTransformer{compilerOptions: compilerOptions, resolver: resolver, metaDataProvider: metaDataProvider}
return tx.newTransformer(tx.visit, emitContext)
}

Expand All @@ -41,12 +42,12 @@ func (tx *ImpliedModuleTransformer) visitSourceFile(node *ast.SourceFile) *ast.N
var transformer *Transformer
if format >= core.ModuleKindES2015 {
if tx.esmTransformer == nil {
tx.esmTransformer = NewESModuleTransformer(tx.emitContext, tx.compilerOptions, tx.resolver)
tx.esmTransformer = NewESModuleTransformer(tx.emitContext, tx.compilerOptions, tx.resolver, tx.metaDataProvider)
}
transformer = tx.esmTransformer
} else {
if tx.cjsTransformer == nil {
tx.cjsTransformer = NewCommonJSModuleTransformer(tx.emitContext, tx.compilerOptions, tx.resolver)
tx.cjsTransformer = NewCommonJSModuleTransformer(tx.emitContext, tx.compilerOptions, tx.resolver, tx.metaDataProvider)
}
transformer = tx.cjsTransformer
}
Expand All @@ -56,5 +57,5 @@ func (tx *ImpliedModuleTransformer) visitSourceFile(node *ast.SourceFile) *ast.N

func (tx *ImpliedModuleTransformer) getEmitModuleFormatOfFile(node *ast.SourceFile) core.ModuleKind {
// !!! host.getEmitModuleFormatOfFile?
return ast.GetEmitModuleFormatOfFileWorker(node, tx.compilerOptions, tx.emitContext.GetSourceFileMetaData(node))
return ast.GetEmitModuleFormatOfFileWorker(node, tx.compilerOptions, tx.metaDataProvider.GetSourceFileMetaData(node))
}
21 changes: 21 additions & 0 deletions internal/transformers/metadataprovider.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package transformers

import "github.com/microsoft/typescript-go/internal/ast"

type MetaDataProvider interface {
GetSourceFileMetaData(file *ast.SourceFile) *ast.SourceFileMetaData
}

type metaDataProvider struct {
getSourceFileMetaData func(file *ast.SourceFile) *ast.SourceFileMetaData
}

func NewMetaDataProvider(getSourceFileMetaData func(file *ast.SourceFile) *ast.SourceFileMetaData) MetaDataProvider {
return &metaDataProvider{
getSourceFileMetaData: getSourceFileMetaData,
}
}

func (r *metaDataProvider) GetSourceFileMetaData(file *ast.SourceFile) *ast.SourceFileMetaData {
return r.getSourceFileMetaData(file)
}