Update dependency esbuild to ^0.16.0
This MR contains the following updates:
Package | Type | Update | Change |
---|---|---|---|
esbuild | dependencies | minor | ^0.15.0 -> ^0.16.0 |
⚠ Dependency Lookup Warnings ⚠
Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.
Release Notes
evanw/esbuild
v0.16.8
-
Allow plugins to resolve injected files (#2754)
Previously paths passed to the
inject
feature were always interpreted as file system paths. This meant thatonResolve
plugins would not be run for them and esbuild's default path resolver would always be used. This meant that theinject
feature couldn't be used in the browser since the browser doesn't have access to a file system. This release runs paths passed toinject
through esbuild's full path resolution pipeline so plugins now have a chance to handle them usingonResolve
callbacks. This makes it possible to write a plugin that makes esbuild'sinject
work in the browser. -
Add the
empty
loader (#1541, #2753)The new
empty
loader tells esbuild to pretend that a file is empty. So for example--loader:.css=empty
effectively skips all imports of.css
files in JavaScript so that they aren't included in the bundle, sinceimport "./some-empty-file"
in JavaScript doesn't bundle anything. You can also use theempty
loader to remove asset references in CSS files. For example--loader:.png=empty
causes esbuild to replace asset references such asurl(image.png)
withurl()
so that they are no longer included in the resulting style sheet. -
Fix
</script>
and</style>
escaping for non-default targets (#2748)The change in version 0.16.0 to give control over
</script>
escaping via--supported:inline-script=false
or--supported:inline-script=true
accidentally broke automatic escaping of</script>
when an explicittarget
setting is specified. This release restores the correct automatic escaping of</script>
(which should not depend on whattarget
is set to). -
Enable the
exports
field withNODE_PATHS
(#2752)Node has a rarely-used feature where you can extend the set of directories that node searches for packages using the
NODE_PATHS
environment variable. While esbuild supports this too, previously it only supported the oldmain
field path resolution but did not support the newexports
field package resolution. This release makes the path resolution rules the same again for bothnode_modules
directories andNODE_PATHS
directories.
v0.16.7
-
Include
file
loader strings in metafile imports (#2731)Bundling a file with the
file
loader copies that file to the output directory and imports a module with the path to the copied file in thedefault
export. Previously when bundling with thefile
loader, there was no reference in the metafile from the JavaScript file containing the path string to the copied file. With this release, there will now be a reference in the metafile in theimports
array with the kindfile-loader
:{ ... "outputs": { "out/image-55CCFTCE.svg": { ... }, "out/entry.js": { "imports": [ + { + "path": "out/image-55CCFTCE.svg", + "kind": "file-loader" + } ], ... } } }
-
Fix byte counts in metafile regarding references to other output files (#2071)
Previously files that contained references to other output files had slightly incorrect metadata for the byte counts of input files which contributed to that output file. So for example if
app.js
importsimage.png
using the file loader and esbuild generatesout.js
andimage-LSAMBFUD.png
, the metadata for how many bytes ofout.js
are fromapp.js
was slightly off (the metadata for the byte count ofout.js
was still correct). The reason is because esbuild substitutes the final paths for references between output files toward the end of the build to handle cyclic references, and the byte counts needed to be adjusted as well during the path substitution. This release fixes these byte counts (specifically thebytesInOutput
values). -
The alias feature now strips a trailing slash (#2730)
People sometimes add a trailing slash to the name of one of node's built-in modules to force node to import from the file system instead of importing the built-in module. For example, importing
util
imports node's built-in module calledutil
but importingutil/
tries to find a package calledutil
on the file system. Previously attempting to use esbuild's package alias feature to replace imports toutil
with a specific file would fail because the file path would also gain a trailing slash (e.g. mappingutil
to./file.js
turnedutil/
into./file.js/
). With this release, esbuild will now omit the path suffix if it's a single trailing slash, which should now allow you to successfully apply aliases to these import paths.
v0.16.6
-
Do not mark subpath imports as external with
--packages=external
(#2741)Node has a feature called subpath imports where special import paths that start with
#
are resolved using theimports
field in thepackage.json
file of the enclosing package. The intent of the newly-added--packages=external
setting is to exclude a package's dependencies from the bundle. Since a package's subpath imports are only accessible within that package, it's wrong for them to be affected by--packages=external
. This release changes esbuild so that--packages=external
no longer affects subpath imports. -
Forbid invalid numbers in JSON files
Previously esbuild parsed numbers in JSON files using the same syntax as JavaScript. But starting from this release, esbuild will now parse them with JSON syntax instead. This means the following numbers are no longer allowed by esbuild in JSON files:
- Legacy octal literals (non-zero integers starting with
0
) - The
0b
,0o
, and0x
numeric prefixes - Numbers containing
_
such as1_000
- Leading and trailing
.
such as0.
and.0
- Numbers with a space after the
-
such as- 1
- Legacy octal literals (non-zero integers starting with
-
Add external imports to metafile (#905, #1768, #1933, #1939)
External imports now appear in
imports
arrays in the metafile (which is present when bundling withmetafile: true
) next to normal imports, but additionally haveexternal: true
to set them apart. This applies both to files in theinputs
section and theoutputs
section. Here's an example:{ "inputs": { "style.css": { "bytes": 83, "imports": [ + { + "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css", + "kind": "import-rule", + "external": true + } ] }, "app.js": { "bytes": 100, "imports": [ + { + "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js", + "kind": "import-statement", + "external": true + }, { "path": "style.css", "kind": "import-statement" } ] } }, "outputs": { "out/app.js": { "imports": [ + { + "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js", + "kind": "require-call", + "external": true + } ], "exports": [], "entryPoint": "app.js", "cssBundle": "out/app.css", "inputs": { "app.js": { "bytesInOutput": 113 }, "style.css": { "bytesInOutput": 0 } }, "bytes": 528 }, "out/app.css": { "imports": [ + { + "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css", + "kind": "import-rule", + "external": true + } ], "inputs": { "style.css": { "bytesInOutput": 0 } }, "bytes": 100 } } }
One additional useful consequence of this is that the
imports
array is now populated when bundling is disabled. So you can now use esbuild with bundling disabled to inspect a file's imports.
v0.16.5
-
Make it easy to exclude all packages from a bundle (#1958, #1975, #2164, #2246, #2542)
When bundling for node, it's often necessary to exclude npm packages from the bundle since they weren't designed with esbuild bundling in mind and don't work correctly after being bundled. For example, they may use
__dirname
and run-time file system calls to load files, which doesn't work after bundling with esbuild. Or they may compile a native.node
extension that has similar expectations about the layout of the file system that are no longer true after bundling (even if the.node
extension is copied next to the bundle).The way to get this to work with esbuild is to use the
--external:
flag. For example, thefsevents
package contains a native.node
extension and shouldn't be bundled. To bundle code that uses it, you can pass--external:fsevents
to esbuild to exclude it from your bundle. You will then need to ensure that thefsevents
package is still present when you run your bundle (e.g. by publishing your bundle to npm as a package with a dependency onfsevents
).It was possible to automatically do this for all of your dependencies, but it was inconvenient. You had to write some code that read your
package.json
file and passed the keys of thedependencies
,devDependencies
,peerDependencies
, and/oroptionalDependencies
maps to esbuild as external packages (either that or write a plugin to mark all package paths as external). Previously esbuild's recommendation for making this easier was to do--external:./node_modules/*
(added in version 0.14.13). However, this was a bad idea because it caused compatibility problems with many node packages as it caused esbuild to mark the post-resolve path as external instead of the pre-resolve path. Doing that could break packages that are published as both CommonJS and ESM if esbuild's bundler is also used to do a module format conversion.With this release, you can now do the following to automatically exclude all packages from your bundle:
-
CLI:
esbuild --bundle --packages=external
-
JS:
esbuild.build({ bundle: true, packages: 'external', })
-
Go:
api.Build(api.BuildOptions{ Bundle: true, Packages: api.PackagesExternal, })
Doing
--external:./node_modules/*
is still possible and still has the same behavior, but is no longer recommended. I recommend that you use the newpackages
feature instead. -
-
Fix some subtle bugs with tagged template literals
This release fixes a bug where minification could incorrectly change the value of
this
within tagged template literal function calls:// Original code function f(x) { let z = y.z return z`` } // Old output (with --minify) function f(n){return y.z``} // New output (with --minify) function f(n){return(0,y.z)``}
This release also fixes a bug where using optional chaining with
--target=es2019
or earlier could incorrectly change the value ofthis
within tagged template literal function calls:// Original code var obj = { foo: function() { console.log(this === obj); } }; (obj?.foo)``; // Old output (with --target=es6) var obj = { foo: function() { console.log(this === obj); } }; (obj == null ? void 0 : obj.foo)``; // New output (with --target=es6) var __freeze = Object.freeze; var __defProp = Object.defineProperty; var __template = (cooked, raw) => __freeze(__defProp(cooked, "raw", { value: __freeze(raw || cooked.slice()) })); var _a; var obj = { foo: function() { console.log(this === obj); } }; (obj == null ? void 0 : obj.foo).call(obj, _a || (_a = __template([""])));
-
Some slight minification improvements
The following minification improvements were implemented:
-
if (~a !== 0) throw x;
=>if (~a) throw x;
-
if ((a | b) !== 0) throw x;
=>if (a | b) throw x;
-
if ((a & b) !== 0) throw x;
=>if (a & b) throw x;
-
if ((a ^ b) !== 0) throw x;
=>if (a ^ b) throw x;
-
if ((a << b) !== 0) throw x;
=>if (a << b) throw x;
-
if ((a >> b) !== 0) throw x;
=>if (a >> b) throw x;
-
if ((a >>> b) !== 0) throw x;
=>if (a >>> b) throw x;
-
if (!!a || !!b) throw x;
=>if (a || b) throw x;
-
if (!!a && !!b) throw x;
=>if (a && b) throw x;
-
if (a ? !!b : !!c) throw x;
=>if (a ? b : c) throw x;
-
v0.16.4
-
Fix binary downloads from the
@esbuild/
scope for Deno (#2729)Version 0.16.0 of esbuild moved esbuild's binary executables into npm packages under the
@esbuild/
scope, which accidentally broke the binary downloader script for Deno. This release fixes this script so it should now be possible to use esbuild version 0.16.4+ with Deno.
v0.16.3
-
Fix a hang with the JS API in certain cases (#2727)
A change that was made in version 0.15.13 accidentally introduced a case when using esbuild's JS API could cause the node process to fail to exit. The change broke esbuild's watchdog timer, which detects if the parent process no longer exists and then automatically exits esbuild. This hang happened when you ran node as a child process with the
stderr
stream set topipe
instead ofinherit
, in the child process you call esbuild's JS API and passincremental: true
but do not calldispose()
on the returnedrebuild
object, and then callprocess.exit()
. In that case the parent node process was still waiting for the esbuild process that was created by the child node process to exit. The change made in version 0.15.13 was trying to avoid using Go'ssync.WaitGroup
API incorrectly because the API is not thread-safe. Instead of doing this, I have now reverted that change and implemented a thread-safe version of thesync.WaitGroup
API for esbuild to use instead.
v0.16.2
-
Fix
process.env.NODE_ENV
substitution when transforming (#2718)Version 0.16.0 introduced an unintentional regression that caused
process.env.NODE_ENV
to be automatically substituted with either"development"
or"production"
when using esbuild'stransform
API. This substitution is a necessary feature of esbuild'sbuild
API because the React framework crashes when you bundle it without doing this. But thetransform
API is typically used as part of a larger build pipeline so the benefit of esbuild doing this automatically is not as clear, and esbuild previously didn't do this.However, version 0.16.0 switched the default value of the
platform
setting for thetransform
API fromneutral
tobrowser
, both to align it with esbuild's documentation (which saysbrowser
is the default value) and because escaping the</script>
character sequence is now tied to thebrowser
platform (see the release notes for version 0.16.0 for details). That accidentally enabled automatic substitution ofprocess.env.NODE_ENV
because esbuild always did that for code meant for the browser. To fix this regression, esbuild will now only automatically substituteprocess.env.NODE_ENV
when using thebuild
API. -
Prevent
define
from substituting constants into assignment position (#2719)The
define
feature lets you replace certain expressions with constants. For example, you could use it to replace references to the global property referencewindow.DEBUG
withfalse
at compile time, which can then potentially help esbuild remove unused code from your bundle. It's similar to DefinePlugin in Webpack.However, if you write code such as
window.DEBUG = true
and then definedwindow.DEBUG
tofalse
, esbuild previously generated the outputfalse = true
which is a syntax error in JavaScript. This behavior is not typically a problem because it doesn't make sense to substitutewindow.DEBUG
with a constant if its value changes at run-time (Webpack'sDefinePlugin
also generatesfalse = true
in this case). But it can be alarming to have esbuild generate code with a syntax error.So with this release, esbuild will no longer substitute
define
constants into assignment position to avoid generating code with a syntax error. Instead esbuild will generate a warning, which currently looks like this:▲ [WARNING] Suspicious assignment to defined constant "window.DEBUG" [assign-to-define] example.js:1:0: 1 │ window.DEBUG = true ╵ ~~~~~~~~~~~~ The expression "window.DEBUG" has been configured to be replaced with a constant using the "define" feature. If this expression is supposed to be a compile-time constant, then it doesn't make sense to assign to it here. Or if this expression is supposed to change at run-time, this "define" substitution should be removed.
-
Fix a regression with
npm install --no-optional
(#2720)Normally when you install esbuild with
npm install
, npm itself is the tool that downloads the correct binary executable for the current platform. This happens because of how esbuild's primary package uses npm'soptionalDependencies
feature. However, if you deliberately disable this withnpm install --no-optional
then esbuild's install script will attempt to repair the installation by manually downloading and extracting the binary executable from the package that was supposed to be installed.The change in version 0.16.0 to move esbuild's nested packages into the
@esbuild/
scope unintentionally broke this logic because of how npm's URL structure is different for scoped packages vs. normal packages. It was actually already broken for a few platforms earlier because esbuild already had packages for some platforms in the@esbuild/
scope, but I didn't discover this then because esbuild's integration tests aren't run on all platforms. Anyway, this release contains some changes to the install script that should hopefully get this scenario working again.
v0.16.1
This is a hotfix for the previous release.
-
Re-allow importing JSON with the
copy
loader using an import assertionThe previous release made it so when
assert { type: 'json' }
is present on an import statement, esbuild validated that thejson
loader was used. This is what an import assertion is supposed to do. However, I forgot about the relatively newcopy
loader, which sort of behaves as if the import path was marked as external (and thus not loaded at all) except that the file is copied to the output directory and the import path is rewritten to point to the copy. In this case whatever JavaScript runtime ends up running the code is the one to evaluate the import assertion. So esbuild should really allow this case as well. With this release, esbuild now allows both thejson
andcopy
loaders when anassert { type: 'json' }
import assertion is present.
v0.16.0
This release deliberately contains backwards-incompatible changes. To avoid automatically picking up releases like this, you should either be pinning the exact version of esbuild
in your package.json
file (recommended) or be using a version range syntax that only accepts patch upgrades such as ^0.15.0
or ~0.15.0
. See npm's documentation about semver for more information.
-
Move all binary executable packages to the
@esbuild/
scopeBinary package executables for esbuild are published as individual packages separate from the main
esbuild
package so you only have to download the relevant one for the current platform when you install esbuild. This release moves all of these packages under the@esbuild/
scope to avoid collisions with 3rd-party packages. It also changes them to a consistent naming scheme that uses theos
andcpu
names from node.The package name changes are as follows:
-
@esbuild/linux-loong64
=>@esbuild/linux-loong64
(no change) -
esbuild-android-64
=>@esbuild/android-x64
-
esbuild-android-arm64
=>@esbuild/android-arm64
-
esbuild-darwin-64
=>@esbuild/darwin-x64
-
esbuild-darwin-arm64
=>@esbuild/darwin-arm64
-
esbuild-freebsd-64
=>@esbuild/freebsd-x64
-
esbuild-freebsd-arm64
=>@esbuild/freebsd-arm64
-
esbuild-linux-32
=>@esbuild/linux-ia32
-
esbuild-linux-64
=>@esbuild/linux-x64
-
esbuild-linux-arm
=>@esbuild/linux-arm
-
esbuild-linux-arm64
=>@esbuild/linux-arm64
-
esbuild-linux-mips64le
=>@esbuild/linux-mips64el
-
esbuild-linux-ppc64le
=>@esbuild/linux-ppc64
-
esbuild-linux-riscv64
=>@esbuild/linux-riscv64
-
esbuild-linux-s390x
=>@esbuild/linux-s390x
-
esbuild-netbsd-64
=>@esbuild/netbsd-x64
-
esbuild-openbsd-64
=>@esbuild/openbsd-x64
-
esbuild-sunos-64
=>@esbuild/sunos-x64
-
esbuild-wasm
=>esbuild-wasm
(no change) -
esbuild-windows-32
=>@esbuild/win32-ia32
-
esbuild-windows-64
=>@esbuild/win32-x64
-
esbuild-windows-arm64
=>@esbuild/win32-arm64
-
esbuild
=>esbuild
(no change)
Normal usage of the
esbuild
andesbuild-wasm
packages should not be affected. These name changes should only affect tools that hard-coded the individual binary executable package names into custom esbuild downloader scripts.This change was not made with performance in mind. But as a bonus, installing esbuild with npm may potentially happen faster now. This is because npm's package installation protocol is inefficient: it always downloads metadata for all past versions of each package even when it only needs metadata about a single version. This makes npm package downloads O(n) in the number of published versions, which penalizes packages like esbuild that are updated regularly. Since most of esbuild's package names have now changed, npm will now need to download much less data when installing esbuild (8.72mb of package manifests before this change → 0.06mb of package manifests after this change). However, this is only a temporary improvement. Installing esbuild will gradually get slower again as further versions of esbuild are published.
-
-
Publish a shell script that downloads esbuild directly
In addition to all of the existing ways to install esbuild, you can now also download esbuild directly like this:
curl -fsSL https://esbuild.github.io/dl/latest | sh
This runs a small shell script that downloads the latest
esbuild
binary executable to the current directory. This can be convenient on systems that don't havenpm
installed or when you just want to get a copy of esbuild quickly without any extra steps. If you want a specific version of esbuild (starting with this version onward), you can provide that version in the URL instead oflatest
:curl -fsSL https://esbuild.github.io/dl/v0.16.0 | sh
Note that the download script needs to be able to access registry.npmjs.org to be able to complete the download. This download script doesn't yet support all of the platforms that esbuild supports because I lack the necessary testing environments. If the download script doesn't work for you because you're on an unsupported platform, please file an issue on the esbuild repo so we can add support for it.
-
Fix some parameter names for the Go API
This release changes some parameter names for the Go API to be consistent with the JavaScript and CLI APIs:
-
OutExtensions
=>OutExtension
-
JSXMode
=>JSX
-
-
Add additional validation of API parameters
The JavaScript API now does some additional validation of API parameters to catch incorrect uses of esbuild's API. The biggest impact of this is likely that esbuild now strictly only accepts strings with the
define
parameter. This would already have been a type error with esbuild's TypeScript type definitions, but it was previously not enforced for people using esbuild's API JavaScript without TypeScript.The
define
parameter appears at first glance to take a JSON object if you aren't paying close attention, but this actually isn't true. Values fordefine
are instead strings of JavaScript code. This means you have to usedefine: { foo: '"bar"' }
to replacefoo
with the string"bar"
. Usingdefine: { foo: 'bar' }
actually replacesfoo
with the identifierbar
. Previously esbuild allowed you to passdefine: { foo: false }
andfalse
was automatically converted into a string, which made it more confusing to understand whatdefine
actually represents. Starting with this release, passing non-string values such as withdefine: { foo: false }
will no longer be allowed. You will now have to writedefine: { foo: 'false' }
instead. -
Generate shorter data URLs if possible (#1843)
Loading a file with esbuild's
dataurl
loader generates a JavaScript module with a data URL for that file in a string as a single default export. Previously the data URLs generated by esbuild all used base64 encoding. However, this is unnecessarily long for most textual data (e.g. SVG images). So with this release, esbuild'sdataurl
loader will now use percent encoding instead of base64 encoding if the result will be shorter. This can result in ~25% smaller data URLs for large SVGs. If you want the old behavior, you can use thebase64
loader instead and then construct the data URL yourself. -
Avoid marking entry points as external (#2382)
Previously you couldn't specify
--external:*
to mark all import paths as external because that also ended up making the entry point itself external, which caused the build to fail. With this release, esbuild'sexternal
API parameter no longer applies to entry points so using--external:*
is now possible.One additional consequence of this change is that the
kind
parameter is now required when calling theresolve()
function in esbuild's plugin API. Previously thekind
parameter defaulted toentry-point
, but that no longer interacts withexternal
so it didn't seem wise for this to continue to be the default. You now have to specifykind
so that the path resolution mode is explicit. -
Disallow non-
default
imports whenassert { type: 'json' }
is presentThere is now standard behavior for importing a JSON file into an ES module using an
import
statement. However, it requires you to place theassert { type: 'json' }
import assertion after the import path. This import assertion tells the JavaScript runtime to throw an error if the import does not end up resolving to a JSON file. On the web, the type of a file is determined by theContent-Type
HTTP header instead of by the file extension. The import assertion prevents security problems on the web where a.json
file may actually resolve to a JavaScript file containing malicious code, which is likely not expected for an import that is supposed to only contain pure side-effect free data.By default, esbuild uses the file extension to determine the type of a file, so this import assertion is unnecessary with esbuild. However, esbuild's JSON import feature has a non-standard extension that allows you to import top-level properties of the JSON object as named imports. For example, esbuild lets you do this:
import { version } from './package.json'
This is useful for tree-shaking when bundling because it means esbuild will only include the the
version
field ofpackage.json
in your bundle. This is non-standard behavior though and doesn't match the behavior of what happens when you import JSON in a real JavaScript runtime (after addingassert { type: 'json' }
). In a real JavaScript runtime the only thing you can import is thedefault
import. So with this release, esbuild will now prevent you from importing non-default
import names ifassert { type: 'json' }
is present. This ensures that code containingassert { type: 'json' }
isn't relying on non-standard behavior that won't work everywhere. So the following code is now an error with esbuild when bundling:import { version } from './package.json' assert { type: 'json' }
In addition, adding
assert { type: 'json' }
to an import statement now means esbuild will generate an error if the loader for the file is anything other thanjson
, which is required by the import assertion specification. -
Provide a way to disable automatic escaping of
</script>
(#2649)If you inject esbuild's output into a script tag in an HTML file, code containing the literal characters
</script>
will cause the tag to be ended early which will break the code:<script> console.log("</script>"); </script>
To avoid this, esbuild automatically escapes these strings in generated JavaScript files (e.g.
"</script>"
becomes"<\/script>"
instead). This also applies to</style>
in generated CSS files. Previously this always happened and there wasn't a way to turn this off.With this release, esbuild will now only do this if the
platform
setting is set tobrowser
(the default value). Settingplatform
tonode
orneutral
will disable this behavior. This behavior can also now be disabled with--supported:inline-script=false
(for JS) and--supported:inline-style=false
(for CSS). -
Throw an early error if decoded UTF-8 text isn't a
Uint8Array
(#2532)If you run esbuild's JavaScript API in a broken JavaScript environment where
new TextEncoder().encode("") instanceof Uint8Array
is false, then esbuild's API will fail with a confusing serialization error message that makes it seem like esbuild has a bug even though the real problem is that the JavaScript environment itself is broken. This can happen when using the test framework called Jest. With this release, esbuild's API will now throw earlier when it detects that the environment is unable to encode UTF-8 text correctly with an error message that makes it more clear that this is not a problem with esbuild. -
Change the default "legal comment" behavior
The legal comments feature automatically gathers comments containing
@license
or@preserve
and puts the comments somewhere (either in the generated code or in a separate file). People sometimes want this to happen so that the their dependencies' software licenses are retained in the generated output code. By default esbuild puts these comments at the end of the file when bundling. However, people sometimes find this confusing because these comments can be very generic and may not mention which library they come from. So with this release, esbuild will now discard legal comments by default. You now have to opt-in to preserving them if you want this behavior. -
Enable the
module
condition by default (#2417)Package authors want to be able to use the new
exports
field inpackage.json
to provide tree-shakable ESM code for ESM-aware bundlers while simultaneously providing fallback CommonJS code for other cases.Node's proposed way to do this involves using the
import
andrequire
export conditions so that you get the ESM code if you use an import statement and the CommonJS code if you use a require call. However, this has a major drawback: if some code in the bundle uses an import statement and other code in the bundle uses a require call, then you'll get two copies of the same package in the bundle. This is known as the dual package hazard and can lead to bloated bundles or even worse to subtle logic bugs.Webpack supports an alternate solution: an export condition called
module
that takes effect regardless of whether the package was imported using an import statement or a require call. This works because bundlers such as Webpack support importing a ESM using a require call (something node doesn't support). You could already do this with esbuild using--conditions=module
but you previously had to explicitly enable this. Package authors are concerned that esbuild users won't know to do this and will get suboptimal output with their package, so they have requested for esbuild to do this automatically.So with this release, esbuild will now automatically add the
module
condition when there aren't any customconditions
already configured. You can disable this with--conditions=
orconditions: []
(i.e. explicitly clearing all custom conditions). -
Rename the
master
branch tomain
The primary branch for this repository was previously called
master
but is now calledmain
. This change mirrors a similar change in many other projects. -
Remove esbuild's
_exit(0)
hack for WebAssembly (#714)Node had an unfortunate bug where the node process is unnecessarily kept open while a WebAssembly module is being optimized: https://github.com/nodejs/node/issues/36616. This means cases where running
esbuild
should take a few milliseconds can end up taking many seconds instead.The workaround was to force node to exit by ending the process early. This was done by esbuild in one of two ways depending on the exit code. For non-zero exit codes (i.e. when there is a build error), the
esbuild
command could just callprocess.kill(process.pid)
to avoid the hang. But for zero exit codes, esbuild had to load a N-API native node extension that calls the operating system'sexit(0)
function.However, this problem has essentially been fixed in node starting with version 18.3.0. So I have removed this hack from esbuild. If you are using an earlier version of node with
esbuild-wasm
and you don't want theesbuild
command to hang for a while when exiting, you can upgrade to node 18.3.0 or higher to remove the hang.The fix came from a V8 upgrade: this commit enabled dynamic tiering for WebAssembly by default for all projects that use V8's WebAssembly implementation. Previously all functions in the WebAssembly module were optimized in a single batch job but with dynamic tiering, V8 now optimizes individual WebAssembly functions as needed. This avoids unnecessary WebAssembly compilation which allows node to exit on time.
v0.15.18
-
Performance improvements for both JS and CSS
This release brings noticeable performance improvements for JS parsing and for CSS parsing and printing. Here's an example benchmark for using esbuild to pretty-print a single large minified CSS file and JS file:
Test case Previous release This release 4.8mb CSS file 19ms 11ms (1.7x faster) 5.8mb JS file 36ms 32ms (1.1x faster) The performance improvements were very straightforward:
-
Identifiers were being scanned using a generic character advancement function instead of using custom inline code. Advancing past each character involved UTF-8 decoding as well as updating multiple member variables. This was sped up using loop that skips UTF-8 decoding entirely and that only updates member variables once at the end. This is faster because identifiers are plain ASCII in the vast majority of cases, so Unicode decoding is almost always unnecessary.
-
CSS identifiers and CSS strings were still being printed one character at a time. Apparently I forgot to move this part of esbuild's CSS infrastructure beyond the proof-of-concept stage. These were both very obvious in the profiler, so I think maybe I have just never profiled esbuild's CSS printing before?
-
There was unnecessary work being done that was related to source maps when source map output was disabled. I likely haven't observed this before because esbuild's benchmarks always have source maps enabled. This work is now disabled when it's not going to be used.
I definitely should have caught these performance issues earlier. Better late than never I suppose.
-
v0.15.17
-
Search for missing source map code on the file system (#2711)
Source maps are JSON files that map from compiled code back to the original code. They provide the original source code using two arrays:
sources
(required) andsourcesContent
(optional). When bundling is enabled, esbuild is able to bundle code with source maps that was compiled by other tools (e.g. with Webpack) and emit source maps that map all the way back to the original code (e.g. before Webpack compiled it).Previously if the input source maps omitted the optional
sourcesContent
array, esbuild would usenull
for the source content in the source map that it generates (since the source content isn't available). However, sometimes the original source code is actually still present on the file system. With this release, esbuild will now try to find the original source code using the path in thesources
array and will use that instead ofnull
if it was found. -
Fix parsing bug with TypeScript
infer
andextends
(#2712)This release fixes a bug where esbuild incorrectly failed to parse valid TypeScript code that nests
extends
insideinfer
insideextends
, such as in the example below:type A<T> = {}; type B = {} extends infer T extends {} ? A<T> : never;
TypeScript code that does this should now be parsed correctly.
-
Use
WebAssembly.instantiateStreaming
if available (#1036, #1900)Currently the WebAssembly version of esbuild uses
fetch
to downloadesbuild.wasm
and thenWebAssembly.instantiate
to compile it. There is a newer API calledWebAssembly.instantiateStreaming
that both downloads and compiles at the same time, which can be a performance improvement if both downloading and compiling are slow. With this release, esbuild now attempts to useWebAssembly.instantiateStreaming
and falls back to the original approach if that fails.The implementation for this builds on a MR by @lbwa.
-
Preserve Webpack comments inside constructor calls (#2439)
This improves the use of esbuild as a faster TypeScript-to-JavaScript frontend for Webpack, which has special magic comments inside
new Worker()
expressions that affect Webpack's behavior.
v0.15.16
-
Add a package alias feature (#2191)
With this release, you can now easily substitute one package for another at build time with the new
alias
feature. For example,--alias:oldpkg=newpkg
replaces all imports ofoldpkg
withnewpkg
. One use case for this is easily replacing a node-only package with a browser-friendly package in 3rd-party code that you don't control. These new substitutions happen first before all of esbuild's existing path resolution logic.Note that when an import path is substituted using an alias, the resulting import path is resolved in the working directory instead of in the directory containing the source file with the import path. If needed, the working directory can be set with the
cd
command when using the CLI or with theabsWorkingDir
setting when using the JS or Go APIs. -
Fix crash when pretty-printing minified JSX with object spread of object literal with computed property (#2697)
JSX elements are translated to JavaScript function calls and JSX element attributes are translated to properties on a JavaScript object literal. These properties are always either strings (e.g. in
<x y />
,y
is a string) or an object spread (e.g. in<x {...y} />
,y
is an object spread) because JSX doesn't provide syntax for directly passing a computed property as a JSX attribute. However, esbuild's minifier has a rule that tries to inline object spread with an inline object literal in JavaScript. For example,x = { ...{ y } }
is minified tox={y}
when minification is enabled. This means that there is a way to generate a non-string non-spread JSX attribute in esbuild's internal representation. One example is with<x {...{ [y]: z }} />
. When minification is enabled, esbuild's internal representation of this is something like<x [y]={z} />
due to object spread inlining, which is not valid JSX syntax. If this internal representation is then pretty-printed as JSX using--minify --jsx=preserve
, esbuild previously crashed when trying to print this invalid syntax. With this release, esbuild will now print<x {...{[y]:z}}/>
in this scenario instead of crashing.
v0.15.15
-
Remove duplicate CSS rules across files (#2688)
When two or more CSS rules are exactly the same (even if they are not adjacent), all but the last one can safely be removed:
/* Before */ a { color: red; } span { font-weight: bold; } a { color: red; } /* After */ span { font-weight: bold; } a { color: red; }
Previously esbuild only did this transformation within a single source file. But with this release, esbuild will now do this transformation across source files, which may lead to smaller CSS output if the same rules are repeated across multiple CSS source files in the same bundle. This transformation is only enabled when minifying (specifically when syntax minification is enabled).
-
Add
deno
as a valid value fortarget
(#2686)The
target
setting in esbuild allows you to enable or disable JavaScript syntax features for a given version of a set of target JavaScript VMs. Previously Deno was not one of the JavaScript VMs that esbuild supported withtarget
, but it will now be supported starting from this release. For example, versions of Deno older than v1.2 don't support the new||=
operator, so adding e.g.--target=deno1.0
to esbuild now lets you tell esbuild to transpile||=
to older JavaScript. -
Fix the
esbuild-wasm
package in Node v19 (#2683)A recent change to Node v19 added a non-writable
crypto
property to the global object: https://github.com/nodejs/node/pull/44897. This conflicts with Go's WebAssembly shim code, which overwrites the globalcrypto
property. As a result, all Go-based WebAssembly code that uses the built-in shim (including esbuild) is now broken on Node v19. This release of esbuild fixes the issue by reconfiguring the globalcrypto
property to be writable before invoking Go's WebAssembly shim code. -
Fix CSS dimension printing exponent confusion edge case (#2677)
In CSS, a dimension token has a numeric "value" part and an identifier "unit" part. For example, the dimension token
32px
has a value of32
and a unit ofpx
. The unit can be any valid CSS identifier. The value can be any number in floating-point format including an optional exponent (e.g.-3.14e-0
has an exponent ofe-0
). The full details of this syntax are here: https://www.w3.org/TR/css-syntax-3/.To maintain the integrity of the dimension token through the printing process, esbuild must handle the edge case where the unit looks like an exponent. One such case is the dimension
1e\32
which has the value1
and the unite2
. It would be bad if this dimension token was printed such that a CSS parser would parse it as a number token with the value1e2
instead of a dimension token. The way esbuild currently does this is to escape the leadinge
in the dimension unit, so esbuild would parse1e\32
but print1\65 2
(both1e\32
and1\65 2
represent a dimension token with a value of1
and a unit ofe2
).However, there is an even narrower edge case regarding this edge case. If the value part of the dimension token itself has an
e
, then it's not necessary to escape thee
in the dimension unit because a CSS parser won't confuse the unit with the exponent even though it looks like one (since a number can only have at most one exponent). This came up because the grammar for the CSSunicode-range
property uses a hack that lets you specify a hexadecimal range without quotes even though CSS has no token for a hexadecimal range. The hack is to allow the hexadecimal range to be parsed as a dimension token and optionally also a number token. Here is the grammar forunicode-range
:unicode-range = <urange># <urange> = u '+' <ident-token> '?'* | u <dimension-token> '?'* | u <number-token> '?'* | u <number-token> <dimension-token> | u <number-token> <number-token> | u '+' '?'+
and here is an example
unicode-range
declaration that was problematic for esbuild:@​font-face { unicode-range: U+0e2e-0e2f; }
This is parsed as a dimension with a value of
+0e2
and a unit ofe-0e2f
. This was problematic for esbuild because the unit starts withe-0
which could be confused with an exponent when appended after a number, so esbuild was escaping thee
character in the unit. However, this escaping is unnecessary because in this case the dimension value already has an exponent in it. With this release, esbuild will no longer unnecessarily escape thee
in the dimension unit in these cases, which should fix the printing ofunicode-range
declarations.An aside: You may be wondering why esbuild is trying to escape the
e
at all and why it doesn't just pass through the original source code unmodified. The reason why esbuild does this is that, for robustness, esbuild's AST generally tries to omit semantically-unrelated information and esbuild's code printers always try to preserve the semantics of the underlying AST. That way the rest of esbuild's internals can just deal with semantics instead of presentation. They don't have to think about how the AST will be printed when changing the AST. This is the same reason that esbuild's JavaScript AST doesn't have a "parentheses" node (e.g.a * (b + c)
is represented by the ASTmultiply(a, add(b, c))
instead ofmultiply(a, parentheses(add(b, c)))
). Instead, the printer automatically inserts parentheses as necessary to maintain the semantics of the AST, which means all of the optimizations that run over the AST don't have to worry about keeping the parentheses up to date. Similarly, the CSS AST for the dimension token stores the actual unit and the printer makes sure the unit is properly escaped depending on what value it's placed after. All of the other code operating on CSS ASTs doesn't have to worry about parsing escapes to compare units or about keeping escapes up to date when the AST is modified. Hopefully that makes sense. -
Attempt to avoid creating the
node_modules/.cache
directory for people that use Yarn 2+ in Plug'n'Play mode (#2685)When Yarn's PnP mode is enabled, packages installed by Yarn may or may not be put inside
.zip
files. The specific heuristics for when this happens change over time in between Yarn versions. This is problematic for esbuild because esbuild's JavaScript package needs to execute a binary file inside the package. Yarn makes extensive modifications to Node's file system APIs at run time to pretend that.zip
files are normal directories and to make it hard to tell whether a file is real or not (since in theory it doesn't matter). But they haven't modified Node'schild_process.execFileSync
API so attempting to execute a file inside a zip file fails. To get around this, esbuild previously used Node's file system APIs to copy the binary executable to another location before invokingexecFileSync
. Under the hood this caused Yarn to extract the file from the zip file into a real file that can then be run.However, esbuild copied its executable into
node_modules/.cache/esbuild
. This is the official recommendation from the Yarn team for where packages are supposed to put these types of files when Yarn PnP is being used. However, users of Yarn PnP with esbuild find this really annoying because they don't like looking at thenode_modules
directory. With this release, esbuild now sets"preferUnplugged": true
in itspackage.json
files, which tells newer versions of Yarn to not put esbuild's packages in a zip file. There may exist older versions of Yarn that don't supportpreferUnplugged
. In that case esbuild should still copy the executable to a cache directory, so it should still run (hopefully, since I haven't tested this myself). Note that esbuild setting"preferUnplugged": true
may have the side effect of esbuild taking up more space on the file system in the event that multiple platforms are installed simultaneously, or that you're using an older version of Yarn that always installs packages for all platforms. In that case you may want to update to a newer version of Yarn since Yarn has recently changed to only install packages for the current platform.
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.