Skip to content

Commit

Permalink
fix #385, fix #2543, fix #943, fix #2440: tsconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
@evanw
evanw committed Jun 5, 2023
1 parent 76fb8bc commit 4632160
Show file tree
Hide file tree
Showing 14 changed files with 288 additions and 155 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Expand Up @@ -85,6 +85,14 @@

The community has requested that esbuild remove support for TypeScript's `moduleSuffixes` feature, so it has been removed in this release. Instead you can use esbuild's `--resolve-extensions=` feature to select which module suffix you want to build with.

* Apply `--tsconfig=` overrides to `stdin` ([#385](https://github.com/evanw/esbuild/issues/385), [#2543](https://github.com/evanw/esbuild/issues/2543))

When you override esbuild's automatic `tsconfig.json` file detection with `--tsconfig=` to pass a specific `tsconfig.json` file, esbuild previously didn't apply these settings to source code passed via the `stdin` API option. This release changes esbuild's behavior so that settings from `tsconfig.json` also apply to `stdin` source code as well.

* Support `--tsconfig-raw=` in build API calls ([#943](https://github.com/evanw/esbuild/issues/943), [#2440](https://github.com/evanw/esbuild/issues/2440))

Previously if you wanted to override esbuild's automatic `tsconfig.json` file detection, you had to create a new `tsconfig.json` file and pass the file name to esbuild via the `--tsconfig=` flag. With this release, you can now optionally use `--tsconfig-raw=` instead to pass the contents of `tsconfig.json` to esbuild directly instead of passing the file name. For example, you can now use `--tsconfig-raw={"compilerOptions":{"experimentalDecorators":true}}` to enable TypeScript experimental decorators directly using a command-line flag (assuming you escape the quotes correctly using your current shell's quoting rules). The `--tsconfig-raw=` flag previously only worked with transform API calls but with this release, it now works with build API calls too.

These changes are intended to improve esbuild's compatibility with `tsc` and reduce the number of unfortunate behaviors regarding `tsconfig.json` and esbuild.

* Add a workaround for bugs in Safari 16.2 and earlier ([#3072](https://github.com/evanw/esbuild/issues/3072))
Expand Down
5 changes: 4 additions & 1 deletion internal/bundler/bundler.go
View file
Expand Up @@ -1141,10 +1141,13 @@ func ScanBundle(
log.AddError(nil, logger.Range{}, fmt.Sprintf("Failed to read from randomness source: %s", err.Error()))
}

// This may mutate "options" by the "tsconfig.json" override settings
res := resolver.NewResolver(fs, log, caches, &options)

s := scanner{
log: log,
fs: fs,
res: resolver.NewResolver(fs, log, caches, options),
res: res,
caches: caches,
options: options,
timer: timer,
Expand Down
2 changes: 1 addition & 1 deletion internal/bundler_tests/bundler_test.go
View file
Expand Up @@ -153,7 +153,7 @@ func (s *suite) __expectBundledImpl(t *testing.T, args bundled, fsKind fs.MockKi
args.options.AbsOutputFile = unix2win(args.options.AbsOutputFile)
args.options.AbsOutputBase = unix2win(args.options.AbsOutputBase)
args.options.AbsOutputDir = unix2win(args.options.AbsOutputDir)
args.options.TsConfigOverride = unix2win(args.options.TsConfigOverride)
args.options.TSConfigPath = unix2win(args.options.TSConfigPath)
}

// Run the bundler
Expand Down
34 changes: 17 additions & 17 deletions internal/bundler_tests/bundler_tsconfig_test.go
View file
Expand Up @@ -1103,9 +1103,9 @@ func TestTsconfigJsonOverrideMissing(t *testing.T) {
},
entryPaths: []string{"/Users/user/project/src/app/entry.ts"},
options: config.Options{
Mode: config.ModeBundle,
AbsOutputFile: "/Users/user/project/out.js",
TsConfigOverride: "/Users/user/project/other/config-for-ts.json",
Mode: config.ModeBundle,
AbsOutputFile: "/Users/user/project/out.js",
TSConfigPath: "/Users/user/project/other/config-for-ts.json",
},
})
}
Expand Down Expand Up @@ -1148,9 +1148,9 @@ func TestTsconfigJsonOverrideNodeModules(t *testing.T) {
},
entryPaths: []string{"/Users/user/project/src/app/entry.ts"},
options: config.Options{
Mode: config.ModeBundle,
AbsOutputFile: "/Users/user/project/out.js",
TsConfigOverride: "/Users/user/project/other/config-for-ts.json",
Mode: config.ModeBundle,
AbsOutputFile: "/Users/user/project/out.js",
TSConfigPath: "/Users/user/project/other/config-for-ts.json",
},
})
}
Expand All @@ -1162,9 +1162,9 @@ func TestTsconfigJsonOverrideInvalid(t *testing.T) {
},
entryPaths: []string{"/entry.ts"},
options: config.Options{
Mode: config.ModeBundle,
AbsOutputFile: "/out.js",
TsConfigOverride: "/this/file/doesn't/exist/tsconfig.json",
Mode: config.ModeBundle,
AbsOutputFile: "/out.js",
TSConfigPath: "/this/file/doesn't/exist/tsconfig.json",
},
expectedScanLog: `ERROR: Cannot find tsconfig file "this/file/doesn't/exist/tsconfig.json"
`,
Expand Down Expand Up @@ -1918,10 +1918,10 @@ func TestTsConfigExtendsDotWithoutSlash(t *testing.T) {
},
entryPaths: []string{"/Users/user/project/src/main.tsx"},
options: config.Options{
Mode: config.ModeBundle,
AbsOutputDir: "/Users/user/project/out",
OutputFormat: config.FormatESModule,
TsConfigOverride: "/Users/user/project/src/foo.json",
Mode: config.ModeBundle,
AbsOutputDir: "/Users/user/project/out",
OutputFormat: config.FormatESModule,
TSConfigPath: "/Users/user/project/src/foo.json",
},
})
}
Expand Down Expand Up @@ -1967,10 +1967,10 @@ func TestTsConfigExtendsDotWithSlash(t *testing.T) {
},
entryPaths: []string{"/Users/user/project/src/main.tsx"},
options: config.Options{
Mode: config.ModeBundle,
AbsOutputDir: "/Users/user/project/out",
OutputFormat: config.FormatESModule,
TsConfigOverride: "/Users/user/project/src/foo.json",
Mode: config.ModeBundle,
AbsOutputDir: "/Users/user/project/out",
OutputFormat: config.FormatESModule,
TSConfigPath: "/Users/user/project/src/foo.json",
},
expectedScanLog: `Users/user/project/src/foo.json: WARNING: Cannot find base config file "./"
`,
Expand Down
3 changes: 2 additions & 1 deletion internal/config/config.go
View file
Expand Up @@ -351,7 +351,8 @@ type Options struct {
OutputExtensionJS string
OutputExtensionCSS string
GlobalName []string
TsConfigOverride string
TSConfigPath string
TSConfigRaw string
ExtensionToLoader map[string]Loader

PublicPath string
Expand Down
176 changes: 115 additions & 61 deletions internal/resolver/resolver.go
View file
Expand Up @@ -163,6 +163,8 @@ type Resolver struct {
log logger.Log
caches *cache.CacheSet

tsConfigOverride *TSConfigJSON

// These are sets that represent various conditions for the "exports" field
// in package.json.
esmConditionsDefault map[string]bool
Expand Down Expand Up @@ -220,7 +222,7 @@ type resolverQuery struct {
kind ast.ImportKind
}

func NewResolver(fs fs.FS, log logger.Log, caches *cache.CacheSet, options config.Options) *Resolver {
func NewResolver(fs fs.FS, log logger.Log, caches *cache.CacheSet, options *config.Options) *Resolver {
// Filter out non-CSS extensions for CSS "@import" imports
atImportExtensionOrder := make([]string, 0, len(options.ExtensionOrder))
for _, ext := range options.ExtensionOrder {
Expand Down Expand Up @@ -250,17 +252,58 @@ func NewResolver(fs fs.FS, log logger.Log, caches *cache.CacheSet, options confi

fs.Cwd()

return &Resolver{
res := &Resolver{
fs: fs,
log: log,
options: options,
options: *options,
caches: caches,
dirCache: make(map[string]*dirInfo),
atImportExtensionOrder: atImportExtensionOrder,
esmConditionsDefault: esmConditionsDefault,
esmConditionsImport: esmConditionsImport,
esmConditionsRequire: esmConditionsRequire,
}

// Handle the "tsconfig.json" override when the resolver is created. This
// isn't done when we validate the build options both because the code for
// "tsconfig.json" handling is already in the resolver, and because we want
// watch mode to pick up changes to "tsconfig.json" and rebuild.
var debugMeta DebugMeta
if options.TSConfigPath != "" || options.TSConfigRaw != "" {
r := resolverQuery{
Resolver: res,
debugMeta: &debugMeta,
}
var err error
if options.TSConfigPath != "" {
res.tsConfigOverride, err = r.parseTSConfig(options.TSConfigPath, make(map[string]bool))
} else {
source := logger.Source{
KeyPath: logger.Path{Text: fs.Join(fs.Cwd(), "<tsconfig.json>"), Namespace: "file"},
PrettyPath: "<tsconfig.json>",
Contents: options.TSConfigRaw,
}
res.tsConfigOverride, err = r.parseTSConfigFromSource(source, make(map[string]bool))
}
if err != nil {
if err == syscall.ENOENT {
r.log.AddError(nil, logger.Range{}, fmt.Sprintf("Cannot find tsconfig file %q",
PrettyPath(r.fs, logger.Path{Text: options.TSConfigPath, Namespace: "file"})))
} else if err != errParseErrorAlreadyLogged {
r.log.AddError(nil, logger.Range{}, fmt.Sprintf("Cannot read file %q: %s",
PrettyPath(r.fs, logger.Path{Text: options.TSConfigPath, Namespace: "file"}), err.Error()))
}
}
}

// Mutate the provided options by settings from "tsconfig.json" if present
if res.tsConfigOverride != nil {
options.TS.Config = res.tsConfigOverride.Settings
res.tsConfigOverride.JSXSettings.ApplyTo(&options.JSX)
options.TSAlwaysStrict = res.tsConfigOverride.TSAlwaysStrictOrStrict()
}

return res
}

func (res *Resolver) Resolve(sourceDir string, importPath string, kind ast.ImportKind) (*ResolveResult, DebugMeta) {
Expand Down Expand Up @@ -662,44 +705,46 @@ func (r resolverQuery) finalizeResolve(result *ResolveResult) {
}

// Copy various fields from the nearest enclosing "tsconfig.json" file if present
if path == &result.PathPair.Primary && dirInfo.enclosingTSConfigJSON != nil {
// Except don't do this if we're inside a "node_modules" directory. Package
// authors often publish their "tsconfig.json" files to npm because of
// npm's default-include publishing model and because these authors
// probably don't know about ".npmignore" files.
//
// People trying to use these packages with esbuild have historically
// complained that esbuild is respecting "tsconfig.json" in these cases.
// The assumption is that the package author published these files by
// accident.
//
// Ignoring "tsconfig.json" files inside "node_modules" directories breaks
// the use case of publishing TypeScript code and having it be transpiled
// for you, but that's the uncommon case and likely doesn't work with
// many other tools anyway. So now these files are ignored.
if helpers.IsInsideNodeModules(result.PathPair.Primary.Text) {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Ignoring %q because %q is inside \"node_modules\"",
dirInfo.enclosingTSConfigJSON.AbsPath,
result.PathPair.Primary.Text))
}
} else {
result.TSConfig = &dirInfo.enclosingTSConfigJSON.Settings
result.TSConfigJSX = dirInfo.enclosingTSConfigJSON.JSXSettings
result.TSAlwaysStrict = dirInfo.enclosingTSConfigJSON.TSAlwaysStrictOrStrict()

if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("This import is under the effect of %q",
dirInfo.enclosingTSConfigJSON.AbsPath))
if result.TSConfigJSX.JSXFactory != nil {
r.debugLogs.addNote(fmt.Sprintf("\"jsxFactory\" is %q due to %q",
strings.Join(result.TSConfigJSX.JSXFactory, "."),
dirInfo.enclosingTSConfigJSON.AbsPath))
if path == &result.PathPair.Primary {
if tsConfigJSON := r.tsConfigForDir(dirInfo); tsConfigJSON != nil {
// Except don't do this if we're inside a "node_modules" directory. Package
// authors often publish their "tsconfig.json" files to npm because of
// npm's default-include publishing model and because these authors
// probably don't know about ".npmignore" files.
//
// People trying to use these packages with esbuild have historically
// complained that esbuild is respecting "tsconfig.json" in these cases.
// The assumption is that the package author published these files by
// accident.
//
// Ignoring "tsconfig.json" files inside "node_modules" directories breaks
// the use case of publishing TypeScript code and having it be transpiled
// for you, but that's the uncommon case and likely doesn't work with
// many other tools anyway. So now these files are ignored.
if helpers.IsInsideNodeModules(result.PathPair.Primary.Text) {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Ignoring %q because %q is inside \"node_modules\"",
tsConfigJSON.AbsPath,
result.PathPair.Primary.Text))
}
if result.TSConfigJSX.JSXFragmentFactory != nil {
r.debugLogs.addNote(fmt.Sprintf("\"jsxFragment\" is %q due to %q",
strings.Join(result.TSConfigJSX.JSXFragmentFactory, "."),
dirInfo.enclosingTSConfigJSON.AbsPath))
} else {
result.TSConfig = &tsConfigJSON.Settings
result.TSConfigJSX = tsConfigJSON.JSXSettings
result.TSAlwaysStrict = tsConfigJSON.TSAlwaysStrictOrStrict()

if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("This import is under the effect of %q",
tsConfigJSON.AbsPath))
if result.TSConfigJSX.JSXFactory != nil {
r.debugLogs.addNote(fmt.Sprintf("\"jsxFactory\" is %q due to %q",
strings.Join(result.TSConfigJSX.JSXFactory, "."),
tsConfigJSON.AbsPath))
}
if result.TSConfigJSX.JSXFragmentFactory != nil {
r.debugLogs.addNote(fmt.Sprintf("\"jsxFragment\" is %q due to %q",
strings.Join(result.TSConfigJSX.JSXFragmentFactory, "."),
tsConfigJSON.AbsPath))
}
}
}
}
Expand Down Expand Up @@ -755,8 +800,8 @@ func (r resolverQuery) resolveWithoutSymlinks(sourceDir string, sourceDirInfo *d
}

// First, check path overrides from the nearest enclosing TypeScript "tsconfig.json" file
if sourceDirInfo != nil && sourceDirInfo.enclosingTSConfigJSON != nil && sourceDirInfo.enclosingTSConfigJSON.Paths != nil {
if absolute, ok, diffCase := r.matchTSConfigPaths(sourceDirInfo.enclosingTSConfigJSON, importPath); ok {
if tsConfigJSON := r.tsConfigForDir(sourceDirInfo); tsConfigJSON != nil && tsConfigJSON.Paths != nil {
if absolute, ok, diffCase := r.matchTSConfigPaths(tsConfigJSON, importPath); ok {
return &ResolveResult{PathPair: absolute, DifferentCase: diffCase}
}
}
Expand Down Expand Up @@ -902,6 +947,16 @@ type dirInfo struct {
hasNodeModules bool // Is there a "node_modules" subdirectory?
}

func (r resolverQuery) tsConfigForDir(dirInfo *dirInfo) *TSConfigJSON {
if r.tsConfigOverride != nil {
return r.tsConfigOverride
}
if dirInfo != nil {
return dirInfo.enclosingTSConfigJSON
}
return nil
}

func (r resolverQuery) dirInfoCached(path string) *dirInfo {
// First, check the cache
cached, ok := r.dirCache[path]
Expand Down Expand Up @@ -945,7 +1000,6 @@ func (r resolverQuery) parseTSConfig(file string, visited map[string]bool) (*TSC
if visited[file] {
return nil, errParseErrorImportCycle
}
isExtends := len(visited) != 0
visited[file] = true

contents, err, originalError := r.caches.FSCache.ReadFile(r.fs, file)
Expand All @@ -965,8 +1019,13 @@ func (r resolverQuery) parseTSConfig(file string, visited map[string]bool) (*TSC
PrettyPath: PrettyPath(r.fs, keyPath),
Contents: contents,
}
return r.parseTSConfigFromSource(source, visited)
}

func (r resolverQuery) parseTSConfigFromSource(source logger.Source, visited map[string]bool) (*TSConfigJSON, error) {
tracker := logger.MakeLineColumnTracker(&source)
fileDir := r.fs.Dir(file)
fileDir := r.fs.Dir(source.KeyPath.Text)
isExtends := len(visited) > 1

result := ParseTSConfigJSON(r.log, source, &r.caches.JSONCache, func(extends string, extendsRange logger.Range) *TSConfigJSON {
// Note: This doesn't use the normal node module resolution algorithm
Expand Down Expand Up @@ -1163,7 +1222,7 @@ func (r resolverQuery) parseTSConfig(file string, visited map[string]bool) (*TSC

// Suppress warnings about missing base config files inside "node_modules"
pnpError:
if !helpers.IsInsideNodeModules(file) {
if !helpers.IsInsideNodeModules(source.KeyPath.Text) {
r.log.AddID(logger.MsgID_TSConfigJSON_Missing, logger.Warning, &tracker, extendsRange,
fmt.Sprintf("Cannot find base config file %q", extends))
}
Expand All @@ -1178,7 +1237,7 @@ func (r resolverQuery) parseTSConfig(file string, visited map[string]bool) (*TSC
// Warn when people try to set esbuild's target via "tsconfig.json" and esbuild's target is unset
if result.Settings.Target != config.TSTargetUnspecified && r.options.OriginalTargetEnv == "" &&
// Don't warn if the target is "ESNext" since esbuild's target also defaults to "esnext" (so that case is harmless)
result.tsTargetKey.LowerValue != "esnext" && !helpers.IsInsideNodeModules(file) {
result.tsTargetKey.LowerValue != "esnext" && !helpers.IsInsideNodeModules(source.KeyPath.Text) {
var example string
switch logger.API {
case logger.CLIAPI:
Expand Down Expand Up @@ -1320,17 +1379,12 @@ func (r resolverQuery) dirInfoUncached(path string) *dirInfo {
}

// Record if this directory has a tsconfig.json or jsconfig.json file
{
if r.tsConfigOverride == nil {
var tsConfigPath string
if forceTsConfig := r.options.TsConfigOverride; forceTsConfig == "" {
if entry, _ := entries.Get("tsconfig.json"); entry != nil && entry.Kind(r.fs) == fs.FileEntry {
tsConfigPath = r.fs.Join(path, "tsconfig.json")
} else if entry, _ := entries.Get("jsconfig.json"); entry != nil && entry.Kind(r.fs) == fs.FileEntry {
tsConfigPath = r.fs.Join(path, "jsconfig.json")
}
} else if parentInfo == nil {
// If there is a tsconfig.json override, mount it at the root directory
tsConfigPath = forceTsConfig
if entry, _ := entries.Get("tsconfig.json"); entry != nil && entry.Kind(r.fs) == fs.FileEntry {
tsConfigPath = r.fs.Join(path, "tsconfig.json")
} else if entry, _ := entries.Get("jsconfig.json"); entry != nil && entry.Kind(r.fs) == fs.FileEntry {
tsConfigPath = r.fs.Join(path, "jsconfig.json")
}
if tsConfigPath != "" {
var err error
Expand Down Expand Up @@ -2026,17 +2080,17 @@ func (r resolverQuery) loadNodeModules(importPath string, dirInfo *dirInfo, forb
}

// First, check path overrides from the nearest enclosing TypeScript "tsconfig.json" file
if dirInfo.enclosingTSConfigJSON != nil {
if tsConfigJSON := r.tsConfigForDir(dirInfo); tsConfigJSON != nil {
// Try path substitutions first
if dirInfo.enclosingTSConfigJSON.Paths != nil {
if absolute, ok, diffCase := r.matchTSConfigPaths(dirInfo.enclosingTSConfigJSON, importPath); ok {
if tsConfigJSON.Paths != nil {
if absolute, ok, diffCase := r.matchTSConfigPaths(tsConfigJSON, importPath); ok {
return absolute, true, diffCase
}
}

// Try looking up the path relative to the base URL
if dirInfo.enclosingTSConfigJSON.BaseURL != nil {
basePath := r.fs.Join(*dirInfo.enclosingTSConfigJSON.BaseURL, importPath)
if tsConfigJSON.BaseURL != nil {
basePath := r.fs.Join(*tsConfigJSON.BaseURL, importPath)
if absolute, ok, diffCase := r.loadAsFileOrDirectory(basePath); ok {
return absolute, true, diffCase
}
Expand Down

0 comments on commit 4632160

Please sign in to comment.