evanw/esbuild
### [`v0.18.5`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0185)
[Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.4...v0.18.5)
- Implement auto accessors ([#3009](https://togithub.com/evanw/esbuild/issues/3009))
This release implements the new auto-accessor syntax from the upcoming [JavaScript decorators proposal](https://togithub.com/tc39/proposal-decorators). The auto-accessor syntax looks like this:
```js
class Foo {
accessor foo;
static accessor bar;
}
new Foo().foo = Foo.bar;
```
This syntax is not yet a part of JavaScript but it was [added to TypeScript in version 4.9](https://devblogs.microsoft.com/typescript/announcing-typescript-4-9/#auto-accessors-in-classes). More information about this feature can be found in [microsoft/TypeScript#49705](https://togithub.com/microsoft/TypeScript/pull/49705). Auto-accessors will be transformed if the target is set to something other than `esnext`:
```js
// Output (with --target=esnext)
class Foo {
accessor foo;
static accessor bar;
}
new Foo().foo = Foo.bar;
// Output (with --target=es2022)
class Foo {
#foo;
get foo() {
return this.#foo;
}
set foo(_) {
this.#foo = _;
}
static #bar;
static get bar() {
return this.#bar;
}
static set bar(_) {
this.#bar = _;
}
}
new Foo().foo = Foo.bar;
// Output (with --target=es2021)
var _foo, _bar;
class Foo {
constructor() {
__privateAdd(this, _foo, void 0);
}
get foo() {
return __privateGet(this, _foo);
}
set foo(_) {
__privateSet(this, _foo, _);
}
static get bar() {
return __privateGet(this, _bar);
}
static set bar(_) {
__privateSet(this, _bar, _);
}
}
_foo = new WeakMap();
_bar = new WeakMap();
__privateAdd(Foo, _bar, void 0);
new Foo().foo = Foo.bar;
```
You can also now use auto-accessors with esbuild's TypeScript experimental decorator transformation, which should behave the same as decorating the underlying getter/setter pair.
**Please keep in mind that this syntax is not yet part of JavaScript.** This release enables auto-accessors in `.js` files with the expectation that it will be a part of JavaScript soon. However, esbuild may change or remove this feature in the future if JavaScript ends up changing or removing this feature. Use this feature with caution for now.
- Pass through JavaScript decorators ([#104](https://togithub.com/evanw/esbuild/issues/104))
In this release, esbuild now parses decorators from the upcoming [JavaScript decorators proposal](https://togithub.com/tc39/proposal-decorators) and passes them through to the output unmodified (as long as the language target is set to `esnext`). Transforming JavaScript decorators to environments that don't support them has not been implemented yet. The only decorator transform that esbuild currently implements is still the TypeScript experimental decorator transform, which only works in `.ts` files and which requires `"experimentalDecorators": true` in your `tsconfig.json` file.
- Static fields with assign semantics now use static blocks if possible
Setting `useDefineForClassFields` to false in TypeScript requires rewriting class fields to assignment statements. Previously this was done by removing the field from the class body and adding an assignment statement after the class declaration. However, this also caused any private fields to also be lowered by necessity (in case a field initializer uses a private symbol, either directly or indirectly). This release changes this transform to use an inline static block if it's supported, which avoids needing to lower private fields in this scenario:
```js
// Original code
class Test {
static #foo = 123
static bar = this.#foo
}
// Old output (with useDefineForClassFields=false)
var _foo;
const _Test = class _Test {
};
_foo = new WeakMap();
__privateAdd(_Test, _foo, 123);
_Test.bar = __privateGet(_Test, _foo);
let Test = _Test;
// New output (with useDefineForClassFields=false)
class Test {
static #foo = 123;
static {
this.bar = this.#foo;
}
}
```
- Fix TypeScript experimental decorators combined with `--mangle-props` ([#3177](https://togithub.com/evanw/esbuild/issues/3177))
Previously using TypeScript experimental decorators combined with the `--mangle-props` setting could result in a crash, as the experimental decorator transform was not expecting a mangled property as a class member. This release fixes the crash so you can now combine both of these features together safely.
### [`v0.18.4`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0184)
[Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.3...v0.18.4)
- Bundling no longer unnecessarily transforms class syntax ([#1360](https://togithub.com/evanw/esbuild/issues/1360), [#1328](https://togithub.com/evanw/esbuild/issues/1328), [#1524](https://togithub.com/evanw/esbuild/issues/1524), [#2416](https://togithub.com/evanw/esbuild/issues/2416))
When bundling, esbuild automatically converts top-level class statements to class expressions. Previously this conversion had the unfortunate side-effect of also transforming certain other class-related syntax features to avoid correctness issues when the references to the class name within the class body. This conversion has been reworked to avoid doing this:
```js
// Original code
export class Foo {
static foo = () => Foo
}
// Old output (with --bundle)
var _Foo = class {
};
var Foo = _Foo;
__publicField(Foo, "foo", () => _Foo);
// New output (with --bundle)
var Foo = class _Foo {
static foo = () => _Foo;
};
```
This conversion process is very complicated and has many edge cases (including interactions with static fields, static blocks, private class properties, and TypeScript experimental decorators). It should already be pretty robust but a change like this may introduce new unintentional behavior. Please report any issues with this upgrade on the esbuild bug tracker.
You may be wondering why esbuild needs to do this at all. One reason to do this is that esbuild's bundler sometimes needs to lazily-evaluate a module. For example, a module may end up being both the target of a dynamic `import()` call and a static `import` statement. Lazy module evaluation is done by wrapping the top-level module code in a closure. To avoid a performance hit for static `import` statements, esbuild stores top-level exported symbols outside of the closure and references them directly instead of indirectly.
Another reason to do this is that multiple JavaScript VMs have had and continue to have performance issues with TDZ (i.e. "temporal dead zone") checks. These checks validate that a let, or const, or class symbol isn't used before it's initialized. Here are two issues with well-known VMs:
- V8: https://bugs.chromium.org/p/v8/issues/detail?id=13723 (10% slowdown)
- JavaScriptCore: https://bugs.webkit.org/show_bug.cgi?id=199866 (1,000% slowdown!)
JavaScriptCore had a severe performance issue as their TDZ implementation had time complexity that was quadratic in the number of variables needing TDZ checks in the same scope (with the top-level scope typically being the worst offender). V8 has ongoing issues with TDZ checks being present throughout the code their JIT generates even when they have already been checked earlier in the same function or when the function in question has already been run (so the checks have already happened).
Due to esbuild's parallel architecture, esbuild both a) needs to convert class statements into class expressions during parsing and b) doesn't yet know whether this module will need to be lazily-evaluated or not in the parser. So esbuild always does this conversion during bundling in case it's needed for correctness (and also to avoid potentially catastrophic performance issues due to bundling creating a large scope with many TDZ variables).
- Enforce TDZ errors in computed class property keys ([#2045](https://togithub.com/evanw/esbuild/issues/2045))
JavaScript allows class property keys to be generated at run-time using code, like this:
```js
class Foo {
static foo = 'foo'
static [Foo.foo + '2'] = 2
}
```
Previously esbuild treated references to the containing class name within computed property keys as a reference to the partially-initialized class object. That meant code that attempted to reference properties of the class object (such as the code above) would get back `undefined` instead of throwing an error.
This release rewrites references to the containing class name within computed property keys into code that always throws an error at run-time, which is how this JavaScript code is supposed to work. Code that does this will now also generate a warning. You should never write code like this, but it now should be more obvious when incorrect code like this is written.
- Fix an issue with experimental decorators and static fields ([#2629](https://togithub.com/evanw/esbuild/issues/2629))
This release also fixes a bug regarding TypeScript experimental decorators and static class fields which reference the enclosing class name in their initializer. This affected top-level classes when bundling was enabled. Previously code that does this could crash because the class name wasn't initialized yet. This case should now be handled correctly:
```ts
// Original code
class Foo {
@someDecorator
static foo = 'foo'
static bar = Foo.foo.length
}
// Old output
const _Foo = class {
static foo = "foo";
static bar = _Foo.foo.length;
};
let Foo = _Foo;
__decorateClass([
someDecorator
], Foo, "foo", 2);
// New output
const _Foo = class _Foo {
static foo = "foo";
static bar = _Foo.foo.length;
};
__decorateClass([
someDecorator
], _Foo, "foo", 2);
let Foo = _Foo;
```
- Fix a minification regression with negative numeric properties ([#3169](https://togithub.com/evanw/esbuild/issues/3169))
Version 0.18.0 introduced a regression where computed properties with negative numbers were incorrectly shortened into a non-computed property when minification was enabled. This regression has been fixed:
```js
// Original code
x = {
[1]: 1,
[-1]: -1,
[NaN]: NaN,
[Infinity]: Infinity,
[-Infinity]: -Infinity,
}
// Old output (with --minify)
x={1:1,-1:-1,NaN:NaN,1/0:1/0,-1/0:-1/0};
// New output (with --minify)
x={1:1,[-1]:-1,NaN:NaN,[1/0]:1/0,[-1/0]:-1/0};
```
### [`v0.18.3`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0183)
[Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.2...v0.18.3)
- Fix a panic due to empty static class blocks ([#3161](https://togithub.com/evanw/esbuild/issues/3161))
This release fixes a bug where an internal invariant that was introduced in the previous release was sometimes violated, which then caused a panic. It happened when bundling code containing an empty static class block with both minification and bundling enabled.
### [`v0.18.2`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0182)
[Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.1...v0.18.2)
- Lower static blocks when static fields are lowered ([#2800](https://togithub.com/evanw/esbuild/issues/2800), [#2950](https://togithub.com/evanw/esbuild/issues/2950), [#3025](https://togithub.com/evanw/esbuild/issues/3025))
This release fixes a bug where esbuild incorrectly did not lower static class blocks when static class fields needed to be lowered. For example, the following code should print `1 2 3` but previously printed `2 1 3` instead due to this bug:
```js
// Original code
class Foo {
static x = console.log(1)
static { console.log(2) }
static y = console.log(3)
}
// Old output (with --supported:class-static-field=false)
class Foo {
static {
console.log(2);
}
}
__publicField(Foo, "x", console.log(1));
__publicField(Foo, "y", console.log(3));
// New output (with --supported:class-static-field=false)
class Foo {
}
__publicField(Foo, "x", console.log(1));
console.log(2);
__publicField(Foo, "y", console.log(3));
```
- Use static blocks to implement `--keep-names` on classes ([#2389](https://togithub.com/evanw/esbuild/issues/2389))
This change fixes a bug where the `name` property could previously be incorrect within a class static context when using `--keep-names`. The problem was that the `name` property was being initialized after static blocks were run instead of before. This has been fixed by moving the `name` property initializer into a static block at the top of the class body:
```js
// Original code
if (typeof Foo === 'undefined') {
let Foo = class {
static test = this.name
}
console.log(Foo.test)
}
// Old output (with --keep-names)
if (typeof Foo === "undefined") {
let Foo2 = /* @__PURE__ */ __name(class {
static test = this.name;
}, "Foo");
console.log(Foo2.test);
}
// New output (with --keep-names)
if (typeof Foo === "undefined") {
let Foo2 = class {
static {
__name(this, "Foo");
}
static test = this.name;
};
console.log(Foo2.test);
}
```
This change was somewhat involved, especially regarding what esbuild considers to be side-effect free. Some unused classes that weren't removed by tree shaking in previous versions of esbuild may now be tree-shaken. One example is classes with static private fields that are transformed by esbuild into code that doesn't use JavaScript's private field syntax. Previously esbuild's tree shaking analysis ran on the class after syntax lowering, but with this release it will run on the class before syntax lowering, meaning it should no longer be confused by class mutations resulting from automatically-generated syntax lowering code.
### [`v0.18.1`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0181)
[Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.0...v0.18.1)
- Fill in `null` entries in input source maps ([#3144](https://togithub.com/evanw/esbuild/issues/3144))
If esbuild bundles input files with source maps and those source maps contain a `sourcesContent` array with `null` entries, esbuild previously copied those `null` entries over to the output source map. With this release, esbuild will now attempt to fill in those `null` entries by looking for a file on the file system with the corresponding name from the `sources` array. This matches esbuild's existing behavior that automatically generates the `sourcesContent` array from the file system if the entire `sourcesContent` array is missing.
- Support `/* @__KEY__ */` comments for mangling property names ([#2574](https://togithub.com/evanw/esbuild/issues/2574))
Property mangling is an advanced feature that enables esbuild to minify certain property names, even though it's not possible to automatically determine that it's safe to do so. The safe property names are configured via regular expression such as `--mangle-props=_$` (mangle all properties ending in `_`).
Sometimes it's desirable to also minify strings containing property names, even though it's not possible to automatically determine which strings are property names. This release makes it possible to do this by annotating those strings with `/* @__KEY__ */`. This is a convention that Terser added earlier this year, and which esbuild is now following too: [https://github.com/terser/terser/pull/1365](https://togithub.com/terser/terser/pull/1365). Using it looks like this:
```js
// Original code
console.log(
[obj.mangle_, obj.keep],
[obj.get('mangle_'), obj.get('keep')],
[obj.get(/* @__KEY__ */ 'mangle_'), obj.get(/* @__KEY__ */ 'keep')],
)
// Old output (with --mangle-props=_$)
console.log(
[obj.a, obj.keep],
[obj.get("mangle_"), obj.get("keep")],
[obj.get(/* @__KEY__ */ "mangle_"), obj.get(/* @__KEY__ */ "keep")]
);
// New output (with --mangle-props=_$)
console.log(
[obj.a, obj.keep],
[obj.get("mangle_"), obj.get("keep")],
[obj.get(/* @__KEY__ */ "a"), obj.get(/* @__KEY__ */ "keep")]
);
```
- Support `/* @__NO_SIDE_EFFECTS__ */` comments for functions ([#3149](https://togithub.com/evanw/esbuild/issues/3149))
Rollup has recently added support for `/* @__NO_SIDE_EFFECTS__ */` annotations before functions to indicate that calls to these functions can be removed if the result is unused (i.e. the calls can be assumed to have no side effects). This release adds basic support for these to esbuild as well, which means esbuild will now parse these comments in input files and preserve them in output files. This should help people that use esbuild in combination with Rollup.
Note that this doesn't necessarily mean esbuild will treat these calls as having no side effects, as esbuild's parallel architecture currently isn't set up to enable this type of cross-file tree-shaking information (tree-shaking decisions regarding a function call are currently local to the file they appear in). If you want esbuild to consider a function call to have no side effects, make sure you continue to annotate the function call with `/* @__PURE__ */` (which is the previously-established convention for communicating this).
### [`v0.18.0`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0180)
[Compare Source](https://togithub.com/evanw/esbuild/compare/v0.17.19...v0.18.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.17.0` or `~0.17.0`. See npm's documentation about [semver](https://docs.npmjs.com/cli/v6/using-npm/semver/) for more information.
The breaking changes in this release mainly focus on fixing some long-standing issues with esbuild's handling of `tsconfig.json` files. Here are all the changes in this release, in detail:
- Add a way to try esbuild online ([#797](https://togithub.com/evanw/esbuild/issues/797))
There is now a way to try esbuild live on esbuild's website without installing it: https://esbuild.github.io/try/. In addition to being able to more easily evaluate esbuild, this should also make it more efficient to generate esbuild bug reports. For example, you can use it to compare the behavior of different versions of esbuild on the same input. The state of the page is stored in the URL for easy sharing. Many thanks to [@hyrious](https://togithub.com/hyrious) for creating https://hyrious.me/esbuild-repl/, which was the main inspiration for this addition to esbuild's website.
Two forms of build options are supported: either CLI-style ([example](https://esbuild.github.io/try/#dAAwLjE3LjE5AC0tbG9hZGVyPXRzeCAtLW1pbmlmeSAtLXNvdXJjZW1hcABsZXQgZWw6IEpTWC5FbGVtZW50ID0gPGRpdiAvPg)) or JS-style ([example](https://esbuild.github.io/try/#dAAwLjE3LjE5AHsKICBsb2FkZXI6ICd0c3gnLAogIG1pbmlmeTogdHJ1ZSwKICBzb3VyY2VtYXA6IHRydWUsCn0AbGV0IGVsOiBKU1guRWxlbWVudCA9IDxkaXYgLz4)). Both are converted into a JS object that's passed to esbuild's WebAssembly API. The CLI-style argument parser is a custom one that simulates shell quoting rules, and the JS-style argument parser is also custom and parses a superset of JSON (basically JSON5 + regular expressions). So argument parsing is an approximate simulation of what happens for real but hopefully it should be close enough.
- Changes to esbuild's `tsconfig.json` support ([#3019](https://togithub.com/evanw/esbuild/issues/3019)):
This release makes the following changes to esbuild's `tsconfig.json` support:
- Using experimental decorators now requires `"experimentalDecorators": true` ([#104](https://togithub.com/evanw/esbuild/issues/104))
Previously esbuild would always compile decorators in TypeScript code using TypeScript's experimental decorator transform. Now that standard JavaScript decorators are close to being finalized, esbuild will now require you to use `"experimentalDecorators": true` to do this. This new requirement makes it possible for esbuild to introduce a transform for standard JavaScript decorators in TypeScript code in the future. Such a transform has not been implemented yet, however.
- TypeScript's `target` no longer affects esbuild's `target` ([#2628](https://togithub.com/evanw/esbuild/issues/2628))
Some people requested that esbuild support TypeScript's `target` setting, so support for it was added (in [version 0.12.4](https://togithub.com/evanw/esbuild/releases/v0.12.4)). However, esbuild supports reading from multiple `tsconfig.json` files within a single build, which opens up the possibility that different files in the build have different language targets configured. There isn't really any reason to do this and it can lead to unexpected results. So with this release, the `target` setting in `tsconfig.json` will no longer affect esbuild's own `target` setting. You will have to use esbuild's own target setting instead (which is a single, global value).
- TypeScript's `jsx` setting no longer causes esbuild to preserve JSX syntax ([#2634](https://togithub.com/evanw/esbuild/issues/2634))
TypeScript has a setting called [`jsx`](https://www.typescriptlang.org/tsconfig#jsx) that controls how to transform JSX into JS. The tool-agnostic transform is called `react`, and the React-specific transform is called `react-jsx` (or `react-jsxdev`). There is also a setting called `preserve` which indicates JSX should be passed through untransformed. Previously people would run esbuild with `"jsx": "preserve"` in their `tsconfig.json` files and then be surprised when esbuild preserved their JSX. So with this release, esbuild will now ignore `"jsx": "preserve"` in `tsconfig.json` files. If you want to preserve JSX syntax with esbuild, you now have to use `--jsx=preserve`.
Note: Some people have suggested that esbuild's equivalent `jsx` setting override the one in `tsconfig.json`. However, some projects need to legitimately have different files within the same build use different transforms (i.e. `react` vs. `react-jsx`) and having esbuild's global `jsx` setting override `tsconfig.json` would prevent this from working. This release ignores `"jsx": "preserve"` but still allows other `jsx` values in `tsconfig.json` files to override esbuild's global `jsx` setting to keep the ability for multiple files within the same build to use different transforms.
- `useDefineForClassFields` behavior has changed ([#2584](https://togithub.com/evanw/esbuild/issues/2584), [#2993](https://togithub.com/evanw/esbuild/issues/2993))
Class fields in TypeScript look like this (`x` is a class field):
```js
class Foo {
x = 123
}
```
TypeScript has legacy behavior that uses assignment semantics instead of define semantics for class fields when [`useDefineForClassFields`](https://www.typescriptlang.org/tsconfig#useDefineForClassFields) is enabled (in which case class fields in TypeScript behave differently than they do in JavaScript, which is arguably "wrong").
This legacy behavior exists because TypeScript added class fields to TypeScript before they were added to JavaScript. The TypeScript team decided to go with assignment semantics and shipped their implementation. Much later on TC39 decided to go with define semantics for class fields in JavaScript instead. This behaves differently if the base class has a setter with the same name:
```js
class Base {
set x(_) {
console.log('x:', _)
}
}
// useDefineForClassFields: false
class AssignSemantics extends Base {
constructor() {
super()
this.x = 123
}
}
// useDefineForClassFields: true
class DefineSemantics extends Base {
constructor() {
super()
Object.defineProperty(this, 'x', { value: 123 })
}
}
console.log(
new AssignSemantics().x, // Calls the setter
new DefineSemantics().x // Doesn't call the setter
)
```
When you run `tsc`, the value of `useDefineForClassFields` defaults to `false` when it's not specified and the `target` in `tsconfig.json` is present but earlier than `ES2022`. This sort of makes sense because the class field language feature was added in ES2022, so before ES2022 class fields didn't exist (and thus TypeScript's legacy behavior is active). However, TypeScript's `target` setting currently defaults to `ES3` which unfortunately means that the `useDefineForClassFields` setting currently defaults to false (i.e. to "wrong"). In other words if you run `tsc` with all default settings, class fields will behave incorrectly.
Previously esbuild tried to do what `tsc` did. That meant esbuild's version of `useDefineForClassFields` was `false` by default, and was also `false` if esbuild's `--target=` was present but earlier than `es2022`. However, TypeScript's legacy class field behavior is becoming increasingly irrelevant and people who expect class fields in TypeScript to work like they do in JavaScript are confused when they use esbuild with default settings. It's also confusing that the behavior of class fields would change if you changed the language target (even though that's exactly how TypeScript works).
So with this release, esbuild will now only use the information in `tsconfig.json` to determine whether `useDefineForClassFields` is true or not. Specifically `useDefineForClassFields` will be respected if present, otherwise it will be `false` if `target` is present in `tsconfig.json` and is `ES2021` or earlier, otherwise it will be `true`. Targets passed to esbuild's `--target=` setting will no longer affect `useDefineForClassFields`.
Note that this means different directories in your build can have different values for this setting since esbuild allows different directories to have different `tsconfig.json` files within the same build. This should let you migrate your code one directory at a time without esbuild's `--target=` setting affecting the semantics of your code.
- Add support for `verbatimModuleSyntax` from TypeScript 5.0
TypeScript 5.0 added a new option called [`verbatimModuleSyntax`](https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax) that deprecates and replaces two older options, `preserveValueImports` and `importsNotUsedAsValues`. Setting `verbatimModuleSyntax` to true in `tsconfig.json` tells esbuild to not drop unused import statements. Specifically esbuild now treats `"verbatimModuleSyntax": true` as if you had specified both `"preserveValueImports": true` and `"importsNotUsedAsValues": "preserve"`.
- Add multiple inheritance for `tsconfig.json` from TypeScript 5.0
TypeScript 5.0 now allows [multiple inheritance for `tsconfig.json` files](https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#supporting-multiple-configuration-files-in-extends). You can now pass an array of filenames via the `extends` parameter and your `tsconfig.json` will start off containing properties from all of those configuration files, in order. This release of esbuild adds support for this new TypeScript feature.
- Remove support for `moduleSuffixes` ([#2395](https://togithub.com/evanw/esbuild/issues/2395))
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` and virtual files ([#385](https://togithub.com/evanw/esbuild/issues/385), [#2543](https://togithub.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 or to TypeScript files from plugins that weren't in the `file` namespace. This release changes esbuild's behavior so that settings from `tsconfig.json` also apply to these source code files as well.
- Support `--tsconfig-raw=` in build API calls ([#943](https://togithub.com/evanw/esbuild/issues/943), [#2440](https://togithub.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.
- Ignore all `tsconfig.json` files in `node_modules` ([#276](https://togithub.com/evanw/esbuild/issues/276), [#2386](https://togithub.com/evanw/esbuild/issues/2386))
This changes esbuild's behavior that applies `tsconfig.json` to all files in the subtree of the directory containing `tsconfig.json`. In version 0.12.7, esbuild started ignoring `tsconfig.json` files inside `node_modules` folders. The rationale is that people typically do this by mistake and that doing this intentionally is a rare use case that doesn't need to be supported. However, this change only applied to certain syntax-specific settings (e.g. `jsxFactory`) but did not apply to path resolution settings (e.g. `paths`). With this release, esbuild will now ignore all `tsconfig.json` files in `node_modules` instead of only ignoring certain settings.
- Ignore `tsconfig.json` when resolving paths within `node_modules` ([#2481](https://togithub.com/evanw/esbuild/issues/2481))
Previously fields in `tsconfig.json` related to path resolution (e.g. `paths`) were respected for all files in the subtree containing that `tsconfig.json` file, even within a nested `node_modules` subdirectory. This meant that a project's `paths` settings could potentially affect any bundled packages. With this release, esbuild will no longer use `tsconfig.json` settings during path resolution inside nested `node_modules` subdirectories.
- Prefer `.js` over `.ts` within `node_modules` ([#3019](https://togithub.com/evanw/esbuild/issues/3019))
The default list of implicit extensions that esbuild will try appending to import paths contains `.ts` before `.js`. This makes it possible to bundle TypeScript projects that reference other files in the project using extension-less imports (e.g. `./some-file` to load `./some-file.ts` instead of `./some-file.js`). However, this behavior is undesirable within `node_modules` directories. Some package authors publish both their original TypeScript code and their compiled JavaScript code side-by-side. In these cases, esbuild should arguably be using the compiled JavaScript files instead of the original TypeScript files because the TypeScript compilation settings for files within the package should be determined by the package author, not the user of esbuild. So with this release, esbuild will now prefer implicit `.js` extensions over `.ts` when searching for import paths within `node_modules`.
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://togithub.com/evanw/esbuild/issues/3072))
Safari's JavaScript parser had a bug (which has now been fixed) where at least something about unary/binary operators nested inside default arguments nested inside either a function or class expression was incorrectly considered a syntax error if that expression was the target of a property assignment. Here are some examples that trigger this Safari bug:
❱ x(function (y = -1) {}.z = 2)
SyntaxError: Left hand side of operator '=' must be a reference.
❱ x(class { f(y = -1) {} }.z = 2)
SyntaxError: Left hand side of operator '=' must be a reference.
It's not clear what the exact conditions are that trigger this bug. However, a workaround for this bug appears to be to post-process your JavaScript to wrap any in function and class declarations that are the direct target of a property access expression in parentheses. That's the workaround that UglifyJS applies for this issue: [mishoo/UglifyJS#2056](https://togithub.com/mishoo/UglifyJS/pull/2056). So that's what esbuild now does starting with this release:
```js
// Original code
x(function (y = -1) {}.z = 2, class { f(y = -1) {} }.z = 2)
// Old output (with --minify --target=safari16.2)
x(function(c=-1){}.z=2,class{f(c=-1){}}.z=2);
// New output (with --minify --target=safari16.2)
x((function(c=-1){}).z=2,(class{f(c=-1){}}).z=2);
```
This fix is not enabled by default. It's only enabled when `--target=` contains Safari 16.2 or earlier, such as with `--target=safari16.2`. You can also explicitly enable or disable this specific transform (called `function-or-class-property-access`) with `--supported:function-or-class-property-access=false`.
- Fix esbuild's TypeScript type declarations to forbid unknown properties ([#3089](https://togithub.com/evanw/esbuild/issues/3089))
Version 0.17.0 of esbuild introduced a specific form of function overloads in the TypeScript type definitions for esbuild's API calls that looks like this:
```ts
interface TransformOptions {
legalComments?: 'none' | 'inline' | 'eof' | 'external'
}
interface TransformResult {
legalComments: string | (ProvidedOptions['legalComments'] extends 'external' ? never : undefined)
}
declare function transformSync(input: string, options?: ProvidedOptions): TransformResult
declare function transformSync(input: string, options?: TransformOptions): TransformResult
```
This more accurately reflects how esbuild's JavaScript API behaves. The result object returned by `transformSync` only has the `legalComments` property if you pass `legalComments: 'external'`:
```ts
// These have type "string | undefined"
transformSync('').legalComments
transformSync('', { legalComments: 'eof' }).legalComments
// This has type "string"
transformSync('', { legalComments: 'external' }).legalComments
```
However, this form of function overloads unfortunately allows typos (e.g. `egalComments`) to pass the type checker without generating an error as TypeScript allows all objects with unknown properties to extend `TransformOptions`. These typos result in esbuild's API throwing an error at run-time.
To prevent typos during type checking, esbuild's TypeScript type definitions will now use a different form that looks like this:
```ts
type SameShape = In & { [Key in Exclude]: never }
interface TransformOptions {
legalComments?: 'none' | 'inline' | 'eof' | 'external'
}
interface TransformResult {
legalComments: string | (ProvidedOptions['legalComments'] extends 'external' ? never : undefined)
}
declare function transformSync(input: string, options?: SameShape): TransformResult
```
This change should hopefully not affect correct code. It should hopefully introduce type errors only for incorrect code.
- Fix CSS nesting transform for pseudo-elements ([#3119](https://togithub.com/evanw/esbuild/issues/3119))
This release fixes esbuild's CSS nesting transform for pseudo-elements (e.g. `::before` and `::after`). The CSS nesting specification says that [the nesting selector does not work with pseudo-elements](https://www.w3.org/TR/css-nesting-1/#ref-for-matches-pseudo%E2%91%A0). This can be seen in the example below: esbuild does not carry the parent pseudo-element `::before` through the nesting selector `&`. However, that doesn't apply to pseudo-elements that are within the same selector. Previously esbuild had a bug where it considered pseudo-elements in both locations as invalid. This release changes esbuild to only consider those from the parent selector invalid, which should align with the specification:
```css
/* Original code */
a, b::before {
&.c, &::after {
content: 'd';
}
}
/* Old output (with --target=chrome90) */
a:is(.c, ::after) {
content: "d";
}
/* New output (with --target=chrome90) */
a.c,
a::after {
content: "d";
}
```
- Forbid `&` before a type selector in nested CSS
The people behind the work-in-progress CSS nesting specification have very recently [decided to forbid nested CSS that looks like `&div`](https://togithub.com/w3c/csswg-drafts/issues/8662#issuecomment-1514977935). You will have to use either `div&` or `&:is(div)` instead. This release of esbuild has been updated to take this new change into consideration. Doing this now generates a warning. The suggested fix is slightly different depending on where in the overall selector it happened:
▲ [WARNING] Cannot use type selector "input" directly after nesting selector "&" [css-syntax-error]
example.css:2:3:
2 │ &input {
│ ~~~~~
╵ :is(input)
CSS nesting syntax does not allow the "&" selector to come before a type selector. You can wrap
this selector in ":is()" as a workaround. This restriction exists to avoid problems with SASS
nesting, where the same syntax means something very different that has no equivalent in real CSS
(appending a suffix to the parent selector).
▲ [WARNING] Cannot use type selector "input" directly after nesting selector "&" [css-syntax-error]
example.css:6:8:
6 │ .form &input {
│ ~~~~~~
╵ input&
CSS nesting syntax does not allow the "&" selector to come before a type selector. You can move
the "&" to the end of this selector as a workaround. This restriction exists to avoid problems
with SASS nesting, where the same syntax means something very different that has no equivalent in
real CSS (appending a suffix to the parent selector).
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
0.17.19->0.18.5Release Notes
evanw/esbuild
### [`v0.18.5`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0185) [Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.4...v0.18.5) - Implement auto accessors ([#3009](https://togithub.com/evanw/esbuild/issues/3009)) This release implements the new auto-accessor syntax from the upcoming [JavaScript decorators proposal](https://togithub.com/tc39/proposal-decorators). The auto-accessor syntax looks like this: ```js class Foo { accessor foo; static accessor bar; } new Foo().foo = Foo.bar; ``` This syntax is not yet a part of JavaScript but it was [added to TypeScript in version 4.9](https://devblogs.microsoft.com/typescript/announcing-typescript-4-9/#auto-accessors-in-classes). More information about this feature can be found in [microsoft/TypeScript#49705](https://togithub.com/microsoft/TypeScript/pull/49705). Auto-accessors will be transformed if the target is set to something other than `esnext`: ```js // Output (with --target=esnext) class Foo { accessor foo; static accessor bar; } new Foo().foo = Foo.bar; // Output (with --target=es2022) class Foo { #foo; get foo() { return this.#foo; } set foo(_) { this.#foo = _; } static #bar; static get bar() { return this.#bar; } static set bar(_) { this.#bar = _; } } new Foo().foo = Foo.bar; // Output (with --target=es2021) var _foo, _bar; class Foo { constructor() { __privateAdd(this, _foo, void 0); } get foo() { return __privateGet(this, _foo); } set foo(_) { __privateSet(this, _foo, _); } static get bar() { return __privateGet(this, _bar); } static set bar(_) { __privateSet(this, _bar, _); } } _foo = new WeakMap(); _bar = new WeakMap(); __privateAdd(Foo, _bar, void 0); new Foo().foo = Foo.bar; ``` You can also now use auto-accessors with esbuild's TypeScript experimental decorator transformation, which should behave the same as decorating the underlying getter/setter pair. **Please keep in mind that this syntax is not yet part of JavaScript.** This release enables auto-accessors in `.js` files with the expectation that it will be a part of JavaScript soon. However, esbuild may change or remove this feature in the future if JavaScript ends up changing or removing this feature. Use this feature with caution for now. - Pass through JavaScript decorators ([#104](https://togithub.com/evanw/esbuild/issues/104)) In this release, esbuild now parses decorators from the upcoming [JavaScript decorators proposal](https://togithub.com/tc39/proposal-decorators) and passes them through to the output unmodified (as long as the language target is set to `esnext`). Transforming JavaScript decorators to environments that don't support them has not been implemented yet. The only decorator transform that esbuild currently implements is still the TypeScript experimental decorator transform, which only works in `.ts` files and which requires `"experimentalDecorators": true` in your `tsconfig.json` file. - Static fields with assign semantics now use static blocks if possible Setting `useDefineForClassFields` to false in TypeScript requires rewriting class fields to assignment statements. Previously this was done by removing the field from the class body and adding an assignment statement after the class declaration. However, this also caused any private fields to also be lowered by necessity (in case a field initializer uses a private symbol, either directly or indirectly). This release changes this transform to use an inline static block if it's supported, which avoids needing to lower private fields in this scenario: ```js // Original code class Test { static #foo = 123 static bar = this.#foo } // Old output (with useDefineForClassFields=false) var _foo; const _Test = class _Test { }; _foo = new WeakMap(); __privateAdd(_Test, _foo, 123); _Test.bar = __privateGet(_Test, _foo); let Test = _Test; // New output (with useDefineForClassFields=false) class Test { static #foo = 123; static { this.bar = this.#foo; } } ``` - Fix TypeScript experimental decorators combined with `--mangle-props` ([#3177](https://togithub.com/evanw/esbuild/issues/3177)) Previously using TypeScript experimental decorators combined with the `--mangle-props` setting could result in a crash, as the experimental decorator transform was not expecting a mangled property as a class member. This release fixes the crash so you can now combine both of these features together safely. ### [`v0.18.4`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0184) [Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.3...v0.18.4) - Bundling no longer unnecessarily transforms class syntax ([#1360](https://togithub.com/evanw/esbuild/issues/1360), [#1328](https://togithub.com/evanw/esbuild/issues/1328), [#1524](https://togithub.com/evanw/esbuild/issues/1524), [#2416](https://togithub.com/evanw/esbuild/issues/2416)) When bundling, esbuild automatically converts top-level class statements to class expressions. Previously this conversion had the unfortunate side-effect of also transforming certain other class-related syntax features to avoid correctness issues when the references to the class name within the class body. This conversion has been reworked to avoid doing this: ```js // Original code export class Foo { static foo = () => Foo } // Old output (with --bundle) var _Foo = class { }; var Foo = _Foo; __publicField(Foo, "foo", () => _Foo); // New output (with --bundle) var Foo = class _Foo { static foo = () => _Foo; }; ``` This conversion process is very complicated and has many edge cases (including interactions with static fields, static blocks, private class properties, and TypeScript experimental decorators). It should already be pretty robust but a change like this may introduce new unintentional behavior. Please report any issues with this upgrade on the esbuild bug tracker. You may be wondering why esbuild needs to do this at all. One reason to do this is that esbuild's bundler sometimes needs to lazily-evaluate a module. For example, a module may end up being both the target of a dynamic `import()` call and a static `import` statement. Lazy module evaluation is done by wrapping the top-level module code in a closure. To avoid a performance hit for static `import` statements, esbuild stores top-level exported symbols outside of the closure and references them directly instead of indirectly. Another reason to do this is that multiple JavaScript VMs have had and continue to have performance issues with TDZ (i.e. "temporal dead zone") checks. These checks validate that a let, or const, or class symbol isn't used before it's initialized. Here are two issues with well-known VMs: - V8: https://bugs.chromium.org/p/v8/issues/detail?id=13723 (10% slowdown) - JavaScriptCore: https://bugs.webkit.org/show_bug.cgi?id=199866 (1,000% slowdown!) JavaScriptCore had a severe performance issue as their TDZ implementation had time complexity that was quadratic in the number of variables needing TDZ checks in the same scope (with the top-level scope typically being the worst offender). V8 has ongoing issues with TDZ checks being present throughout the code their JIT generates even when they have already been checked earlier in the same function or when the function in question has already been run (so the checks have already happened). Due to esbuild's parallel architecture, esbuild both a) needs to convert class statements into class expressions during parsing and b) doesn't yet know whether this module will need to be lazily-evaluated or not in the parser. So esbuild always does this conversion during bundling in case it's needed for correctness (and also to avoid potentially catastrophic performance issues due to bundling creating a large scope with many TDZ variables). - Enforce TDZ errors in computed class property keys ([#2045](https://togithub.com/evanw/esbuild/issues/2045)) JavaScript allows class property keys to be generated at run-time using code, like this: ```js class Foo { static foo = 'foo' static [Foo.foo + '2'] = 2 } ``` Previously esbuild treated references to the containing class name within computed property keys as a reference to the partially-initialized class object. That meant code that attempted to reference properties of the class object (such as the code above) would get back `undefined` instead of throwing an error. This release rewrites references to the containing class name within computed property keys into code that always throws an error at run-time, which is how this JavaScript code is supposed to work. Code that does this will now also generate a warning. You should never write code like this, but it now should be more obvious when incorrect code like this is written. - Fix an issue with experimental decorators and static fields ([#2629](https://togithub.com/evanw/esbuild/issues/2629)) This release also fixes a bug regarding TypeScript experimental decorators and static class fields which reference the enclosing class name in their initializer. This affected top-level classes when bundling was enabled. Previously code that does this could crash because the class name wasn't initialized yet. This case should now be handled correctly: ```ts // Original code class Foo { @someDecorator static foo = 'foo' static bar = Foo.foo.length } // Old output const _Foo = class { static foo = "foo"; static bar = _Foo.foo.length; }; let Foo = _Foo; __decorateClass([ someDecorator ], Foo, "foo", 2); // New output const _Foo = class _Foo { static foo = "foo"; static bar = _Foo.foo.length; }; __decorateClass([ someDecorator ], _Foo, "foo", 2); let Foo = _Foo; ``` - Fix a minification regression with negative numeric properties ([#3169](https://togithub.com/evanw/esbuild/issues/3169)) Version 0.18.0 introduced a regression where computed properties with negative numbers were incorrectly shortened into a non-computed property when minification was enabled. This regression has been fixed: ```js // Original code x = { [1]: 1, [-1]: -1, [NaN]: NaN, [Infinity]: Infinity, [-Infinity]: -Infinity, } // Old output (with --minify) x={1:1,-1:-1,NaN:NaN,1/0:1/0,-1/0:-1/0}; // New output (with --minify) x={1:1,[-1]:-1,NaN:NaN,[1/0]:1/0,[-1/0]:-1/0}; ``` ### [`v0.18.3`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0183) [Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.2...v0.18.3) - Fix a panic due to empty static class blocks ([#3161](https://togithub.com/evanw/esbuild/issues/3161)) This release fixes a bug where an internal invariant that was introduced in the previous release was sometimes violated, which then caused a panic. It happened when bundling code containing an empty static class block with both minification and bundling enabled. ### [`v0.18.2`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0182) [Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.1...v0.18.2) - Lower static blocks when static fields are lowered ([#2800](https://togithub.com/evanw/esbuild/issues/2800), [#2950](https://togithub.com/evanw/esbuild/issues/2950), [#3025](https://togithub.com/evanw/esbuild/issues/3025)) This release fixes a bug where esbuild incorrectly did not lower static class blocks when static class fields needed to be lowered. For example, the following code should print `1 2 3` but previously printed `2 1 3` instead due to this bug: ```js // Original code class Foo { static x = console.log(1) static { console.log(2) } static y = console.log(3) } // Old output (with --supported:class-static-field=false) class Foo { static { console.log(2); } } __publicField(Foo, "x", console.log(1)); __publicField(Foo, "y", console.log(3)); // New output (with --supported:class-static-field=false) class Foo { } __publicField(Foo, "x", console.log(1)); console.log(2); __publicField(Foo, "y", console.log(3)); ``` - Use static blocks to implement `--keep-names` on classes ([#2389](https://togithub.com/evanw/esbuild/issues/2389)) This change fixes a bug where the `name` property could previously be incorrect within a class static context when using `--keep-names`. The problem was that the `name` property was being initialized after static blocks were run instead of before. This has been fixed by moving the `name` property initializer into a static block at the top of the class body: ```js // Original code if (typeof Foo === 'undefined') { let Foo = class { static test = this.name } console.log(Foo.test) } // Old output (with --keep-names) if (typeof Foo === "undefined") { let Foo2 = /* @__PURE__ */ __name(class { static test = this.name; }, "Foo"); console.log(Foo2.test); } // New output (with --keep-names) if (typeof Foo === "undefined") { let Foo2 = class { static { __name(this, "Foo"); } static test = this.name; }; console.log(Foo2.test); } ``` This change was somewhat involved, especially regarding what esbuild considers to be side-effect free. Some unused classes that weren't removed by tree shaking in previous versions of esbuild may now be tree-shaken. One example is classes with static private fields that are transformed by esbuild into code that doesn't use JavaScript's private field syntax. Previously esbuild's tree shaking analysis ran on the class after syntax lowering, but with this release it will run on the class before syntax lowering, meaning it should no longer be confused by class mutations resulting from automatically-generated syntax lowering code. ### [`v0.18.1`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0181) [Compare Source](https://togithub.com/evanw/esbuild/compare/v0.18.0...v0.18.1) - Fill in `null` entries in input source maps ([#3144](https://togithub.com/evanw/esbuild/issues/3144)) If esbuild bundles input files with source maps and those source maps contain a `sourcesContent` array with `null` entries, esbuild previously copied those `null` entries over to the output source map. With this release, esbuild will now attempt to fill in those `null` entries by looking for a file on the file system with the corresponding name from the `sources` array. This matches esbuild's existing behavior that automatically generates the `sourcesContent` array from the file system if the entire `sourcesContent` array is missing. - Support `/* @__KEY__ */` comments for mangling property names ([#2574](https://togithub.com/evanw/esbuild/issues/2574)) Property mangling is an advanced feature that enables esbuild to minify certain property names, even though it's not possible to automatically determine that it's safe to do so. The safe property names are configured via regular expression such as `--mangle-props=_$` (mangle all properties ending in `_`). Sometimes it's desirable to also minify strings containing property names, even though it's not possible to automatically determine which strings are property names. This release makes it possible to do this by annotating those strings with `/* @__KEY__ */`. This is a convention that Terser added earlier this year, and which esbuild is now following too: [https://github.com/terser/terser/pull/1365](https://togithub.com/terser/terser/pull/1365). Using it looks like this: ```js // Original code console.log( [obj.mangle_, obj.keep], [obj.get('mangle_'), obj.get('keep')], [obj.get(/* @__KEY__ */ 'mangle_'), obj.get(/* @__KEY__ */ 'keep')], ) // Old output (with --mangle-props=_$) console.log( [obj.a, obj.keep], [obj.get("mangle_"), obj.get("keep")], [obj.get(/* @__KEY__ */ "mangle_"), obj.get(/* @__KEY__ */ "keep")] ); // New output (with --mangle-props=_$) console.log( [obj.a, obj.keep], [obj.get("mangle_"), obj.get("keep")], [obj.get(/* @__KEY__ */ "a"), obj.get(/* @__KEY__ */ "keep")] ); ``` - Support `/* @__NO_SIDE_EFFECTS__ */` comments for functions ([#3149](https://togithub.com/evanw/esbuild/issues/3149)) Rollup has recently added support for `/* @__NO_SIDE_EFFECTS__ */` annotations before functions to indicate that calls to these functions can be removed if the result is unused (i.e. the calls can be assumed to have no side effects). This release adds basic support for these to esbuild as well, which means esbuild will now parse these comments in input files and preserve them in output files. This should help people that use esbuild in combination with Rollup. Note that this doesn't necessarily mean esbuild will treat these calls as having no side effects, as esbuild's parallel architecture currently isn't set up to enable this type of cross-file tree-shaking information (tree-shaking decisions regarding a function call are currently local to the file they appear in). If you want esbuild to consider a function call to have no side effects, make sure you continue to annotate the function call with `/* @__PURE__ */` (which is the previously-established convention for communicating this). ### [`v0.18.0`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#0180) [Compare Source](https://togithub.com/evanw/esbuild/compare/v0.17.19...v0.18.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.17.0` or `~0.17.0`. See npm's documentation about [semver](https://docs.npmjs.com/cli/v6/using-npm/semver/) for more information. The breaking changes in this release mainly focus on fixing some long-standing issues with esbuild's handling of `tsconfig.json` files. Here are all the changes in this release, in detail: - Add a way to try esbuild online ([#797](https://togithub.com/evanw/esbuild/issues/797)) There is now a way to try esbuild live on esbuild's website without installing it: https://esbuild.github.io/try/. In addition to being able to more easily evaluate esbuild, this should also make it more efficient to generate esbuild bug reports. For example, you can use it to compare the behavior of different versions of esbuild on the same input. The state of the page is stored in the URL for easy sharing. Many thanks to [@hyrious](https://togithub.com/hyrious) for creating https://hyrious.me/esbuild-repl/, which was the main inspiration for this addition to esbuild's website. Two forms of build options are supported: either CLI-style ([example](https://esbuild.github.io/try/#dAAwLjE3LjE5AC0tbG9hZGVyPXRzeCAtLW1pbmlmeSAtLXNvdXJjZW1hcABsZXQgZWw6IEpTWC5FbGVtZW50ID0gPGRpdiAvPg)) or JS-style ([example](https://esbuild.github.io/try/#dAAwLjE3LjE5AHsKICBsb2FkZXI6ICd0c3gnLAogIG1pbmlmeTogdHJ1ZSwKICBzb3VyY2VtYXA6IHRydWUsCn0AbGV0IGVsOiBKU1guRWxlbWVudCA9IDxkaXYgLz4)). Both are converted into a JS object that's passed to esbuild's WebAssembly API. The CLI-style argument parser is a custom one that simulates shell quoting rules, and the JS-style argument parser is also custom and parses a superset of JSON (basically JSON5 + regular expressions). So argument parsing is an approximate simulation of what happens for real but hopefully it should be close enough. - Changes to esbuild's `tsconfig.json` support ([#3019](https://togithub.com/evanw/esbuild/issues/3019)): This release makes the following changes to esbuild's `tsconfig.json` support: - Using experimental decorators now requires `"experimentalDecorators": true` ([#104](https://togithub.com/evanw/esbuild/issues/104)) Previously esbuild would always compile decorators in TypeScript code using TypeScript's experimental decorator transform. Now that standard JavaScript decorators are close to being finalized, esbuild will now require you to use `"experimentalDecorators": true` to do this. This new requirement makes it possible for esbuild to introduce a transform for standard JavaScript decorators in TypeScript code in the future. Such a transform has not been implemented yet, however. - TypeScript's `target` no longer affects esbuild's `target` ([#2628](https://togithub.com/evanw/esbuild/issues/2628)) Some people requested that esbuild support TypeScript's `target` setting, so support for it was added (in [version 0.12.4](https://togithub.com/evanw/esbuild/releases/v0.12.4)). However, esbuild supports reading from multiple `tsconfig.json` files within a single build, which opens up the possibility that different files in the build have different language targets configured. There isn't really any reason to do this and it can lead to unexpected results. So with this release, the `target` setting in `tsconfig.json` will no longer affect esbuild's own `target` setting. You will have to use esbuild's own target setting instead (which is a single, global value). - TypeScript's `jsx` setting no longer causes esbuild to preserve JSX syntax ([#2634](https://togithub.com/evanw/esbuild/issues/2634)) TypeScript has a setting called [`jsx`](https://www.typescriptlang.org/tsconfig#jsx) that controls how to transform JSX into JS. The tool-agnostic transform is called `react`, and the React-specific transform is called `react-jsx` (or `react-jsxdev`). There is also a setting called `preserve` which indicates JSX should be passed through untransformed. Previously people would run esbuild with `"jsx": "preserve"` in their `tsconfig.json` files and then be surprised when esbuild preserved their JSX. So with this release, esbuild will now ignore `"jsx": "preserve"` in `tsconfig.json` files. If you want to preserve JSX syntax with esbuild, you now have to use `--jsx=preserve`. Note: Some people have suggested that esbuild's equivalent `jsx` setting override the one in `tsconfig.json`. However, some projects need to legitimately have different files within the same build use different transforms (i.e. `react` vs. `react-jsx`) and having esbuild's global `jsx` setting override `tsconfig.json` would prevent this from working. This release ignores `"jsx": "preserve"` but still allows other `jsx` values in `tsconfig.json` files to override esbuild's global `jsx` setting to keep the ability for multiple files within the same build to use different transforms. - `useDefineForClassFields` behavior has changed ([#2584](https://togithub.com/evanw/esbuild/issues/2584), [#2993](https://togithub.com/evanw/esbuild/issues/2993)) Class fields in TypeScript look like this (`x` is a class field): ```js class Foo { x = 123 } ``` TypeScript has legacy behavior that uses assignment semantics instead of define semantics for class fields when [`useDefineForClassFields`](https://www.typescriptlang.org/tsconfig#useDefineForClassFields) is enabled (in which case class fields in TypeScript behave differently than they do in JavaScript, which is arguably "wrong"). This legacy behavior exists because TypeScript added class fields to TypeScript before they were added to JavaScript. The TypeScript team decided to go with assignment semantics and shipped their implementation. Much later on TC39 decided to go with define semantics for class fields in JavaScript instead. This behaves differently if the base class has a setter with the same name: ```js class Base { set x(_) { console.log('x:', _) } } // useDefineForClassFields: false class AssignSemantics extends Base { constructor() { super() this.x = 123 } } // useDefineForClassFields: true class DefineSemantics extends Base { constructor() { super() Object.defineProperty(this, 'x', { value: 123 }) } } console.log( new AssignSemantics().x, // Calls the setter new DefineSemantics().x // Doesn't call the setter ) ``` When you run `tsc`, the value of `useDefineForClassFields` defaults to `false` when it's not specified and the `target` in `tsconfig.json` is present but earlier than `ES2022`. This sort of makes sense because the class field language feature was added in ES2022, so before ES2022 class fields didn't exist (and thus TypeScript's legacy behavior is active). However, TypeScript's `target` setting currently defaults to `ES3` which unfortunately means that the `useDefineForClassFields` setting currently defaults to false (i.e. to "wrong"). In other words if you run `tsc` with all default settings, class fields will behave incorrectly. Previously esbuild tried to do what `tsc` did. That meant esbuild's version of `useDefineForClassFields` was `false` by default, and was also `false` if esbuild's `--target=` was present but earlier than `es2022`. However, TypeScript's legacy class field behavior is becoming increasingly irrelevant and people who expect class fields in TypeScript to work like they do in JavaScript are confused when they use esbuild with default settings. It's also confusing that the behavior of class fields would change if you changed the language target (even though that's exactly how TypeScript works). So with this release, esbuild will now only use the information in `tsconfig.json` to determine whether `useDefineForClassFields` is true or not. Specifically `useDefineForClassFields` will be respected if present, otherwise it will be `false` if `target` is present in `tsconfig.json` and is `ES2021` or earlier, otherwise it will be `true`. Targets passed to esbuild's `--target=` setting will no longer affect `useDefineForClassFields`. Note that this means different directories in your build can have different values for this setting since esbuild allows different directories to have different `tsconfig.json` files within the same build. This should let you migrate your code one directory at a time without esbuild's `--target=` setting affecting the semantics of your code. - Add support for `verbatimModuleSyntax` from TypeScript 5.0 TypeScript 5.0 added a new option called [`verbatimModuleSyntax`](https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax) that deprecates and replaces two older options, `preserveValueImports` and `importsNotUsedAsValues`. Setting `verbatimModuleSyntax` to true in `tsconfig.json` tells esbuild to not drop unused import statements. Specifically esbuild now treats `"verbatimModuleSyntax": true` as if you had specified both `"preserveValueImports": true` and `"importsNotUsedAsValues": "preserve"`. - Add multiple inheritance for `tsconfig.json` from TypeScript 5.0 TypeScript 5.0 now allows [multiple inheritance for `tsconfig.json` files](https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#supporting-multiple-configuration-files-in-extends). You can now pass an array of filenames via the `extends` parameter and your `tsconfig.json` will start off containing properties from all of those configuration files, in order. This release of esbuild adds support for this new TypeScript feature. - Remove support for `moduleSuffixes` ([#2395](https://togithub.com/evanw/esbuild/issues/2395)) 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` and virtual files ([#385](https://togithub.com/evanw/esbuild/issues/385), [#2543](https://togithub.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 or to TypeScript files from plugins that weren't in the `file` namespace. This release changes esbuild's behavior so that settings from `tsconfig.json` also apply to these source code files as well. - Support `--tsconfig-raw=` in build API calls ([#943](https://togithub.com/evanw/esbuild/issues/943), [#2440](https://togithub.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. - Ignore all `tsconfig.json` files in `node_modules` ([#276](https://togithub.com/evanw/esbuild/issues/276), [#2386](https://togithub.com/evanw/esbuild/issues/2386)) This changes esbuild's behavior that applies `tsconfig.json` to all files in the subtree of the directory containing `tsconfig.json`. In version 0.12.7, esbuild started ignoring `tsconfig.json` files inside `node_modules` folders. The rationale is that people typically do this by mistake and that doing this intentionally is a rare use case that doesn't need to be supported. However, this change only applied to certain syntax-specific settings (e.g. `jsxFactory`) but did not apply to path resolution settings (e.g. `paths`). With this release, esbuild will now ignore all `tsconfig.json` files in `node_modules` instead of only ignoring certain settings. - Ignore `tsconfig.json` when resolving paths within `node_modules` ([#2481](https://togithub.com/evanw/esbuild/issues/2481)) Previously fields in `tsconfig.json` related to path resolution (e.g. `paths`) were respected for all files in the subtree containing that `tsconfig.json` file, even within a nested `node_modules` subdirectory. This meant that a project's `paths` settings could potentially affect any bundled packages. With this release, esbuild will no longer use `tsconfig.json` settings during path resolution inside nested `node_modules` subdirectories. - Prefer `.js` over `.ts` within `node_modules` ([#3019](https://togithub.com/evanw/esbuild/issues/3019)) The default list of implicit extensions that esbuild will try appending to import paths contains `.ts` before `.js`. This makes it possible to bundle TypeScript projects that reference other files in the project using extension-less imports (e.g. `./some-file` to load `./some-file.ts` instead of `./some-file.js`). However, this behavior is undesirable within `node_modules` directories. Some package authors publish both their original TypeScript code and their compiled JavaScript code side-by-side. In these cases, esbuild should arguably be using the compiled JavaScript files instead of the original TypeScript files because the TypeScript compilation settings for files within the package should be determined by the package author, not the user of esbuild. So with this release, esbuild will now prefer implicit `.js` extensions over `.ts` when searching for import paths within `node_modules`. 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://togithub.com/evanw/esbuild/issues/3072)) Safari's JavaScript parser had a bug (which has now been fixed) where at least something about unary/binary operators nested inside default arguments nested inside either a function or class expression was incorrectly considered a syntax error if that expression was the target of a property assignment. Here are some examples that trigger this Safari bug: ❱ x(function (y = -1) {}.z = 2) SyntaxError: Left hand side of operator '=' must be a reference. ❱ x(class { f(y = -1) {} }.z = 2) SyntaxError: Left hand side of operator '=' must be a reference. It's not clear what the exact conditions are that trigger this bug. However, a workaround for this bug appears to be to post-process your JavaScript to wrap any in function and class declarations that are the direct target of a property access expression in parentheses. That's the workaround that UglifyJS applies for this issue: [mishoo/UglifyJS#2056](https://togithub.com/mishoo/UglifyJS/pull/2056). So that's what esbuild now does starting with this release: ```js // Original code x(function (y = -1) {}.z = 2, class { f(y = -1) {} }.z = 2) // Old output (with --minify --target=safari16.2) x(function(c=-1){}.z=2,class{f(c=-1){}}.z=2); // New output (with --minify --target=safari16.2) x((function(c=-1){}).z=2,(class{f(c=-1){}}).z=2); ``` This fix is not enabled by default. It's only enabled when `--target=` contains Safari 16.2 or earlier, such as with `--target=safari16.2`. You can also explicitly enable or disable this specific transform (called `function-or-class-property-access`) with `--supported:function-or-class-property-access=false`. - Fix esbuild's TypeScript type declarations to forbid unknown properties ([#3089](https://togithub.com/evanw/esbuild/issues/3089)) Version 0.17.0 of esbuild introduced a specific form of function overloads in the TypeScript type definitions for esbuild's API calls that looks like this: ```ts interface TransformOptions { legalComments?: 'none' | 'inline' | 'eof' | 'external' } interface TransformResultConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.