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 all commits
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
7 changes: 5 additions & 2 deletions internal/ast/ast.go
Original file line number Diff line number Diff line change
Expand Up @@ -8666,6 +8666,11 @@ type CommentDirective struct {

// SourceFile

type SourceFileMetaData struct {
PackageJsonType string
ImpliedNodeFormat core.ResolutionMode
}

type SourceFile struct {
NodeBase
DeclarationBase
Expand Down Expand Up @@ -8726,7 +8731,6 @@ type SourceFile struct {

// !!!

ImpliedNodeFormat core.ModuleKind
CommonJsModuleIndicator *Node
ExternalModuleIndicator *Node
JsGlobalAugmentations SymbolTable
Expand Down Expand Up @@ -8811,7 +8815,6 @@ func (node *SourceFile) copyFrom(other *SourceFile) {
node.ReferencedFiles = other.ReferencedFiles
node.TypeReferenceDirectives = other.TypeReferenceDirectives
node.LibReferenceDirectives = other.LibReferenceDirectives
node.ImpliedNodeFormat = other.ImpliedNodeFormat
node.CommonJsModuleIndicator = other.CommonJsModuleIndicator
node.ExternalModuleIndicator = other.ExternalModuleIndicator
node.JsGlobalAugmentations = other.JsGlobalAugmentations
Expand Down
35 changes: 24 additions & 11 deletions internal/ast/utilities.go
Original file line number Diff line number Diff line change
Expand Up @@ -2354,27 +2354,40 @@ func IsDefaultImport(node *Node /*ImportDeclaration | ImportEqualsDeclaration |
return importClause != nil && importClause.AsImportClause().name != nil
}

func GetEmitModuleFormatOfFileWorker(sourceFile *SourceFile, options *core.CompilerOptions) core.ModuleKind {
result := GetImpliedNodeFormatForEmitWorker(sourceFile, options)
func GetImpliedNodeFormatForFile(path string, packageJsonType string) core.ModuleKind {
impliedNodeFormat := core.ResolutionModeNone
if tspath.FileExtensionIsOneOf(path, []string{tspath.ExtensionDmts, tspath.ExtensionMts, tspath.ExtensionMjs}) {
impliedNodeFormat = core.ResolutionModeESM
} else if tspath.FileExtensionIsOneOf(path, []string{tspath.ExtensionDcts, tspath.ExtensionCts, tspath.ExtensionCjs}) {
impliedNodeFormat = core.ResolutionModeCommonJS
} else if packageJsonType != "" && tspath.FileExtensionIsOneOf(path, []string{tspath.ExtensionDts, tspath.ExtensionTs, tspath.ExtensionTsx, tspath.ExtensionJs, tspath.ExtensionJsx}) {
impliedNodeFormat = core.IfElse(packageJsonType == "module", core.ResolutionModeESM, core.ResolutionModeCommonJS)
}

return impliedNodeFormat
}

func GetEmitModuleFormatOfFileWorker(sourceFile *SourceFile, options *core.CompilerOptions, sourceFileMetaData *SourceFileMetaData) core.ModuleKind {
result := GetImpliedNodeFormatForEmitWorker(sourceFile.FileName(), options, sourceFileMetaData)
if result != core.ModuleKindNone {
return result
}
return options.GetEmitModuleKind()
}

func GetImpliedNodeFormatForEmitWorker(sourceFile *SourceFile, options *core.CompilerOptions) core.ResolutionMode {
func GetImpliedNodeFormatForEmitWorker(fileName string, options *core.CompilerOptions, sourceFileMetaData *SourceFileMetaData) core.ModuleKind {
moduleKind := options.GetEmitModuleKind()
if core.ModuleKindNode16 <= moduleKind && moduleKind <= core.ModuleKindNodeNext {
return sourceFile.ImpliedNodeFormat
if core.ModuleKindNode16 <= moduleKind && moduleKind <= core.ModuleKindNodeNext && sourceFileMetaData != nil {
return sourceFileMetaData.ImpliedNodeFormat
}
if sourceFile.ImpliedNodeFormat == core.ModuleKindCommonJS &&
( /*sourceFile.packageJsonScope.contents.packageJsonContent.type == "commonjs" ||*/ // !!!
tspath.FileExtensionIsOneOf(sourceFile.FileName(), []string{tspath.ExtensionCjs, tspath.ExtensionCts})) {
if sourceFileMetaData != nil && sourceFileMetaData.ImpliedNodeFormat == core.ModuleKindCommonJS &&
(sourceFileMetaData.PackageJsonType != "module" ||
tspath.FileExtensionIsOneOf(fileName, []string{tspath.ExtensionCjs, tspath.ExtensionCts})) {
return core.ModuleKindCommonJS
}
if sourceFile.ImpliedNodeFormat == core.ModuleKindESNext &&
( /*sourceFile.packageJsonScope?.contents.packageJsonContent.type === "module" ||*/ // !!!
tspath.FileExtensionIsOneOf(sourceFile.fileName, []string{tspath.ExtensionMjs, tspath.ExtensionMts})) {
if sourceFileMetaData != nil && sourceFileMetaData.ImpliedNodeFormat == core.ModuleKindESNext &&
(sourceFileMetaData.PackageJsonType == "module" ||
tspath.FileExtensionIsOneOf(fileName, []string{tspath.ExtensionMjs, tspath.ExtensionMts})) {
return core.ModuleKindESNext
}
return core.ModuleKindNone
Expand Down
1 change: 1 addition & 0 deletions internal/checker/checker.go
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,7 @@ type Program interface {
GetEmitModuleFormatOfFile(sourceFile *ast.SourceFile) core.ModuleKind
GetImpliedNodeFormatForEmit(sourceFile *ast.SourceFile) core.ModuleKind
GetResolvedModule(currentSourceFile *ast.SourceFile, moduleReference string) *ast.SourceFile
GetSourceFileMetaData(path tspath.Path) *ast.SourceFileMetaData
}

type Host interface{}
Expand Down
6 changes: 4 additions & 2 deletions internal/checker/grammarchecks.go
Original file line number Diff line number Diff line change
Expand Up @@ -1217,7 +1217,8 @@ func (c *Checker) checkGrammarForInOrForOfStatement(forInOrOfStatement *ast.ForI
}
switch c.moduleKind {
case core.ModuleKindNode16, core.ModuleKindNodeNext:
if sourceFile.ImpliedNodeFormat == core.ModuleKindCommonJS {
sourceFileMetaData := c.program.GetSourceFileMetaData(sourceFile.Path())
if sourceFileMetaData != nil && sourceFileMetaData.ImpliedNodeFormat == core.ModuleKindCommonJS {
c.diagnostics.Add(createDiagnosticForNode(forInOrOfStatement.AwaitModifier, diagnostics.The_current_file_is_a_CommonJS_module_and_cannot_use_await_at_the_top_level))
break
}
Expand Down Expand Up @@ -1719,7 +1720,8 @@ func (c *Checker) checkGrammarAwaitOrAwaitUsing(node *ast.Node) bool {
switch c.moduleKind {
case core.ModuleKindNode16,
core.ModuleKindNodeNext:
if sourceFile.ImpliedNodeFormat == core.ModuleKindCommonJS {
sourceFileMetaData := c.program.GetSourceFileMetaData(sourceFile.Path())
if sourceFileMetaData != nil && sourceFileMetaData.ImpliedNodeFormat == core.ModuleKindCommonJS {
if !spanCalculated {
span = scanner.GetRangeOfTokenAtPosition(sourceFile, node.Pos())
}
Expand Down
6 changes: 6 additions & 0 deletions internal/compiler/emitHost.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"github.com/microsoft/typescript-go/internal/ast"
"github.com/microsoft/typescript-go/internal/core"
"github.com/microsoft/typescript-go/internal/printer"
"github.com/microsoft/typescript-go/internal/tspath"
)

type WriteFileData struct {
Expand All @@ -23,6 +24,7 @@ type EmitHost interface {
CommonSourceDirectory() string
IsEmitBlocked(file string) bool
WriteFile(fileName string, text string, writeByteOrderMark bool, relatedSourceFiles []*ast.SourceFile, data *WriteFileData) error
GetSourceFileMetaData(path tspath.Path) *ast.SourceFileMetaData
GetEmitResolver(file *ast.SourceFile, skipDiagnostics bool) printer.EmitResolver
}

Expand Down Expand Up @@ -54,3 +56,7 @@ func (host *emitHost) GetEmitResolver(file *ast.SourceFile, skipDiagnostics bool
checker := host.program.GetTypeCheckerForFile(file)
return checker.GetEmitResolver(file, skipDiagnostics)
}

func (host *emitHost) GetSourceFileMetaData(path tspath.Path) *ast.SourceFileMetaData {
return host.program.GetSourceFileMetaData(path)
}
10 changes: 5 additions & 5 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, sourceFileMetaDataProvider printer.SourceFileMetaDataProvider) *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, sourceFileMetaDataProvider)

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, sourceFileMetaDataProvider)

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

Expand Down Expand Up @@ -89,7 +89,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, e.host))
return tx
}

Expand Down
31 changes: 29 additions & 2 deletions internal/compiler/fileloader.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ type fileLoader struct {
resolvedModulesMutex sync.Mutex
resolvedModules map[tspath.Path]module.ModeAwareCache[*module.ResolvedModule]

sourceFileMetaDatasMutex sync.RWMutex
sourceFileMetaDatas map[tspath.Path]*ast.SourceFileMetaData

mu sync.Mutex
wg core.WorkGroup
tasksByFileName map[string]*parseTask
Expand All @@ -40,7 +43,7 @@ func processAllProgramFiles(
resolver *module.Resolver,
rootFiles []string,
libs []string,
) (files []*ast.SourceFile, resolvedModules map[tspath.Path]module.ModeAwareCache[*module.ResolvedModule]) {
) (files []*ast.SourceFile, resolvedModules map[tspath.Path]module.ModeAwareCache[*module.ResolvedModule], sourceFileMetaDatas map[tspath.Path]*ast.SourceFileMetaData) {
supportedExtensions := tsoptions.GetSupportedExtensions(compilerOptions, nil /*extraFileExtensions*/)
loader := fileLoader{
host: host,
Expand Down Expand Up @@ -76,7 +79,7 @@ func processAllProgramFiles(
}
loader.sortLibs(libFiles)

return append(libFiles, files...), loader.resolvedModules
return append(libFiles, files...), loader.resolvedModules, loader.sourceFileMetaDatas
}

func (p *fileLoader) addRootTasks(files []string, isLib bool) {
Expand Down Expand Up @@ -221,9 +224,33 @@ func (t *parseTask) start(loader *fileLoader) {
})
}

func (p *fileLoader) loadSourceFileMetaData(path tspath.Path) {
p.sourceFileMetaDatasMutex.RLock()
_, ok := p.sourceFileMetaDatas[path]
p.sourceFileMetaDatasMutex.RUnlock()
if ok {
return
}

packageJsonType := p.resolver.GetPackageJsonTypeIfApplicable(string(path))
impliedNodeFormat := ast.GetImpliedNodeFormatForFile(string(path), packageJsonType)
metadata := &ast.SourceFileMetaData{
PackageJsonType: packageJsonType,
ImpliedNodeFormat: impliedNodeFormat,
}

p.sourceFileMetaDatasMutex.Lock()
defer p.sourceFileMetaDatasMutex.Unlock()
if p.sourceFileMetaDatas == nil {
p.sourceFileMetaDatas = make(map[tspath.Path]*ast.SourceFileMetaData)
}
p.sourceFileMetaDatas[path] = metadata
}

func (p *fileLoader) parseSourceFile(fileName string) *ast.SourceFile {
path := tspath.ToPath(fileName, p.host.GetCurrentDirectory(), p.host.FS().UseCaseSensitiveFileNames())
sourceFile := p.host.GetSourceFile(fileName, path, p.compilerOptions.GetEmitScriptTarget())
p.loadSourceFileMetaData(path)
return sourceFile
}

Expand Down
22 changes: 22 additions & 0 deletions internal/compiler/module/resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,28 @@ func (r *Resolver) GetPackageScopeForPath(directory string) *packagejson.InfoCac
return (&resolutionState{compilerOptions: r.compilerOptions, resolver: r}).getPackageScopeForPath(directory)
}

func (r *Resolver) GetPackageJsonTypeIfApplicable(path string) string {
if tspath.FileExtensionIsOneOf(path, []string{tspath.ExtensionMts, tspath.ExtensionCts, tspath.ExtensionMjs, tspath.ExtensionCjs}) {
return ""
}

var moduleResolutionKind core.ModuleResolutionKind
if r.compilerOptions != nil {
moduleResolutionKind = r.compilerOptions.GetModuleResolutionKind()
}

var packageJsonType string
shouldLookupFromPackageJson := core.ModuleResolutionKindNode16 <= moduleResolutionKind && moduleResolutionKind <= core.ModuleResolutionKindNodeNext || strings.Contains(path, "/node_modules/")
if shouldLookupFromPackageJson {
packageJsonScope := r.GetPackageScopeForPath(tspath.GetDirectoryPath(path))
if packageJsonScope.Exists() {
packageJsonType, _ = packageJsonScope.Contents.Type.GetValue()
}
}

return packageJsonType
}

func (r *Resolver) ResolveTypeReferenceDirective(typeReferenceDirectiveName string, containingFile string, resolutionMode core.ResolutionMode, redirectedReference *ResolvedProjectReference) *ResolvedTypeReferenceDirective {
traceEnabled := r.traceEnabled()

Expand Down
15 changes: 10 additions & 5 deletions internal/compiler/program.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ type Program struct {
files []*ast.SourceFile
filesByPath map[tspath.Path]*ast.SourceFile

sourceFileMetaDatas map[tspath.Path]*ast.SourceFileMetaData

// The below settings are to track if a .js file should be add to the program if loaded via searching under node_modules.
// This works as imported modules are discovered recursively in a depth first manner, specifically:
// - For each root file, findSourceFile is called.
Expand All @@ -68,13 +70,12 @@ type Program struct {
unsupportedExtensions []string
}

var extensions = []string{".ts", ".tsx"}

func NewProgram(options ProgramOptions) *Program {
p := &Program{}
p.programOptions = options
p.compilerOptions = options.Options
p.configFileParsingDiagnostics = slices.Clip(options.ConfigFileParsingDiagnostics)
p.sourceFileMetaDatas = make(map[tspath.Path]*ast.SourceFileMetaData)
if p.compilerOptions == nil {
p.compilerOptions = &core.CompilerOptions{}
}
Expand Down Expand Up @@ -152,7 +153,7 @@ func NewProgram(options ProgramOptions) *Program {
}
}

p.files, p.resolvedModules = processAllProgramFiles(p.host, p.programOptions, p.compilerOptions, p.resolver, rootFiles, libs)
p.files, p.resolvedModules, p.sourceFileMetaDatas = processAllProgramFiles(p.host, p.programOptions, p.compilerOptions, p.resolver, rootFiles, libs)
p.filesByPath = make(map[tspath.Path]*ast.SourceFile, len(p.files))
for _, file := range p.files {
p.filesByPath[file.Path()] = file
Expand Down Expand Up @@ -416,16 +417,20 @@ func (p *Program) PrintSourceFileWithTypes() {
}
}

func (p *Program) GetSourceFileMetaData(path tspath.Path) *ast.SourceFileMetaData {
return p.sourceFileMetaDatas[path]
}

func (p *Program) GetEmitModuleFormatOfFile(sourceFile *ast.SourceFile) core.ModuleKind {
return p.GetEmitModuleFormatOfFileWorker(sourceFile, p.compilerOptions)
}

func (p *Program) GetEmitModuleFormatOfFileWorker(sourceFile *ast.SourceFile, options *core.CompilerOptions) core.ModuleKind {
return ast.GetEmitModuleFormatOfFileWorker(sourceFile, options)
return ast.GetEmitModuleFormatOfFileWorker(sourceFile, options, p.GetSourceFileMetaData(sourceFile.Path()))
}

func (p *Program) GetImpliedNodeFormatForEmit(sourceFile *ast.SourceFile) core.ResolutionMode {
return ast.GetImpliedNodeFormatForEmitWorker(sourceFile, p.compilerOptions)
return ast.GetImpliedNodeFormatForEmitWorker(sourceFile.FileName(), p.compilerOptions, p.GetSourceFileMetaData(sourceFile.Path()))
}

func (p *Program) CommonSourceDirectory() string {
Expand Down
10 changes: 10 additions & 0 deletions internal/printer/sourcefilemetadataprovider.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package printer

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

type SourceFileMetaDataProvider interface {
GetSourceFileMetaData(path tspath.Path) *ast.SourceFileMetaData
}
Loading