fix(deps): update dependency esbuild to ^0.17.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
esbuild	^0.16.0 -> ^0.17.0

---

Release Notes

evanw/esbuild

v0.17.8

Compare Source

• Fix a minification bug with non-ASCII identifiers (#​2910)

  This release fixes a bug with esbuild where non-ASCII identifiers followed by a keyword were incorrectly not separated by a space. This bug affected both the in and instanceof keywords. Here's an example of the fix:

  // Original code
  π in a
  
  // Old output (with --minify --charset=utf8)
  πin a;
  
  // New output (with --minify --charset=utf8)
  π in a;

• Fix a regression with esbuild's WebAssembly API in version 0.17.6 (#​2911)

  Version 0.17.6 of esbuild updated the Go toolchain to version 1.20.0. This had the unfortunate side effect of increasing the amount of stack space that esbuild uses (presumably due to some changes to Go's WebAssembly implementation) which could cause esbuild's WebAssembly-based API to crash with a stack overflow in cases where it previously didn't crash. One such case is the package grapheme-splitter which contains code that looks like this:

  if (
    (0x0300 <= code && code <= 0x036F) ||
    (0x0483 <= code && code <= 0x0487) ||
    (0x0488 <= code && code <= 0x0489) ||
    (0x0591 <= code && code <= 0x05BD) ||
    // ... many hundreds of lines later ...
  ) {
    return;
  }

  This edge case involves a chain of binary operators that results in an AST over 400 nodes deep. Normally this wouldn't be a problem because Go has growable call stacks, so the call stack would just grow to be as large as needed. However, WebAssembly byte code deliberately doesn't expose the ability to manipulate the stack pointer, so Go's WebAssembly translation is forced to use the fixed-size WebAssembly call stack. So esbuild's WebAssembly implementation is vulnerable to stack overflow in cases like these.

  It's not unreasonable for this to cause a stack overflow, and for esbuild's answer to this problem to be "don't write code like this." That's how many other AST-manipulation tools handle this problem. However, it's possible to implement AST traversal using iteration instead of recursion to work around limited call stack space. This version of esbuild implements this code transformation for esbuild's JavaScript parser and printer, so esbuild's WebAssembly implementation is now able to process the grapheme-splitter package (at least when compiled with Go 1.20.0 and run with node's WebAssembly implementation).

v0.17.7

Compare Source

• Change esbuild's parsing of TypeScript instantiation expressions to match TypeScript 4.8+ (#​2907)

  This release updates esbuild's implementation of instantiation expression erasure to match microsoft/TypeScript#​49353. The new rules are as follows (copied from TypeScript's PR description):

  When a potential type argument list is followed by

  • a line break,
  • an ( token,
  • a template literal string, or
  • any token except < or > that isn't the start of an expression,

  we consider that construct to be a type argument list. Otherwise we consider the construct to be a < relational expression followed by a > relational expression.

• Ignore sideEffects: false for imported CSS files (#​1370, #​1458, #​2905)

  This release ignores the sideEffects annotation in package.json for CSS files that are imported into JS files using esbuild's css loader. This means that these CSS files are no longer be tree-shaken.

  Importing CSS into JS causes esbuild to automatically create a CSS entry point next to the JS entry point containing the bundled CSS. Previously packages that specified some form of "sideEffects": false could potentially cause esbuild to consider one or more of the JS files on the import path to the CSS file to be side-effect free, which would result in esbuild removing that CSS file from the bundle. This was problematic because the removal of that CSS is outwardly observable, since all CSS is global, so it was incorrect for previous versions of esbuild to tree-shake CSS files imported into JS files.

• Add constant folding for certain additional equality cases (#​2394, #​2895)

  This release adds constant folding for expressions similar to the following:

  // Original input
  console.log(
    null === 'foo',
    null === undefined,
    null == undefined,
    false === 0,
    false == 0,
    1 === true,
    1 == true,
  )
  
  // Old output
  console.log(
    null === "foo",
    null === void 0,
    null == void 0,
    false === 0,
    false == 0,
    1 === true,
    1 == true
  );
  
  // New output
  console.log(
    false,
    false,
    true,
    false,
    true,
    false,
    true
  );

v0.17.6

Compare Source

• Fix a CSS parser crash on invalid CSS (#​2892)

  Previously the following invalid CSS caused esbuild's parser to crash:

  @​media screen

  The crash was caused by trying to construct a helpful error message assuming that there was an opening { token, which is not the case here. This release fixes the crash.

• Inline TypeScript enums that are referenced before their declaration

  Previously esbuild inlined enums within a TypeScript file from top to bottom, which meant that references to TypeScript enum members were only inlined within the same file if they came after the enum declaration. With this release, esbuild will now inline enums even when they are referenced before they are declared:

  // Original input
  export const foo = () => Foo.FOO
  const enum Foo { FOO = 0 }
  
  // Old output (with --tree-shaking=true)
  export const foo = () => Foo.FOO;
  var Foo = /* @​__PURE__ */ ((Foo2) => {
    Foo2[Foo2["FOO"] = 0] = "FOO";
    return Foo2;
  })(Foo || {});
  
  // New output (with --tree-shaking=true)
  export const foo = () => 0 /* FOO */;

  This makes esbuild's TypeScript output smaller and faster when processing code that does this. I noticed this issue when I ran the TypeScript compiler's source code through esbuild's bundler. Now that the TypeScript compiler is going to be bundled with esbuild in the upcoming TypeScript 5.0 release, improvements like this will also improve the TypeScript compiler itself!

• Fix esbuild installation on Arch Linux (#​2785, #​2812, #​2865)

  Someone made an unofficial esbuild package for Linux that adds the ESBUILD_BINARY_PATH=/usr/bin/esbuild environment variable to the user's default environment. This breaks all npm installations of esbuild for users with this unofficial Linux package installed, which has affected many people. Most (all?) people who encounter this problem haven't even installed this unofficial package themselves; instead it was installed for them as a dependency of another Linux package. The problematic change to add the ESBUILD_BINARY_PATH environment variable was reverted in the latest version of this unofficial package. However, old versions of this unofficial package are still there and will be around forever. With this release, ESBUILD_BINARY_PATH is now ignored by esbuild's install script when it's set to the value /usr/bin/esbuild. This should unbreak using npm to install esbuild in these problematic Linux environments.

  Note: The ESBUILD_BINARY_PATH variable is an undocumented way to override the location of esbuild's binary when esbuild's npm package is installed, which is necessary to substitute your own locally-built esbuild binary when debugging esbuild's npm package. It's only meant for very custom situations and should absolutely not be forced on others by default, especially without their knowledge. I may remove the code in esbuild's installer that reads ESBUILD_BINARY_PATH in the future to prevent these kinds of issues. It will unfortunately make debugging esbuild harder. If ESBUILD_BINARY_PATH is ever removed, it will be done in a "breaking change" release.

v0.17.5

Compare Source

• Parse const type parameters from TypeScript 5.0

  The TypeScript 5.0 beta announcement adds const type parameters to the language. You can now add the const modifier on a type parameter of a function, method, or class like this:

  type HasNames = { names: readonly string[] };
  const getNamesExactly = <const T extends HasNames>(arg: T): T["names"] => arg.names;
  const names = getNamesExactly({ names: ["Alice", "Bob", "Eve"] });

  The type of names in the above example is readonly ["Alice", "Bob", "Eve"]. Marking the type parameter as const behaves as if you had written as const at every use instead. The above code is equivalent to the following TypeScript, which was the only option before TypeScript 5.0:

  type HasNames = { names: readonly string[] };
  const getNamesExactly = <T extends HasNames>(arg: T): T["names"] => arg.names;
  const names = getNamesExactly({ names: ["Alice", "Bob", "Eve"] } as const);

  You can read the announcement for more information.

• Make parsing generic async arrow functions more strict in .tsx files

  Previously esbuild's TypeScript parser incorrectly accepted the following code as valid:

  let fn = async <T> () => {};

  The official TypeScript parser rejects this code because it thinks it's the identifier async followed by a JSX element starting with <T>. So with this release, esbuild will now reject this syntax in .tsx files too. You'll now have to add a comma after the type parameter to get generic arrow functions like this to parse in .tsx files:

  let fn = async <T,> () => {};

• Allow the in and out type parameter modifiers on class expressions

  TypeScript 4.7 added the in and out modifiers on the type parameters of classes, interfaces, and type aliases. However, while TypeScript supported them on both class expressions and class statements, previously esbuild only supported them on class statements due to an oversight. This release now allows these modifiers on class expressions too:

  declare let Foo: any;
  Foo = class <in T> { };
  Foo = class <out T> { };

• Update enum constant folding for TypeScript 5.0

  TypeScript 5.0 contains an updated definition of what it considers a constant expression:

  An expression is considered a constant expression if it is

  • a number or string literal,
  • a unary +, -, or ~ applied to a numeric constant expression,
  • a binary +, -, *, /, %, **, <<, >>, >>>, |, &, ^ applied to two numeric constant expressions,
  • a binary + applied to two constant expressions whereof at least one is a string,
  • a template expression where each substitution expression is a constant expression,
  • a parenthesized constant expression,
  • a dotted name (e.g. x.y.z) that references a const variable with a constant expression initializer and no type annotation,
  • a dotted name that references an enum member with an enum literal type, or
  • a dotted name indexed by a string literal (e.g. x.y["z"]) that references an enum member with an enum literal type.

  This impacts esbuild's implementation of TypeScript's const enum feature. With this release, esbuild will now attempt to follow these new rules. For example, you can now initialize an enum member with a template literal expression that contains a numeric constant:

  // Original input
  const enum Example {
    COUNT = 100,
    ERROR = `Expected ${COUNT} items`,
  }
  console.log(
    Example.COUNT,
    Example.ERROR,
  )
  
  // Old output (with --tree-shaking=true)
  var Example = /* @​__PURE__ */ ((Example2) => {
    Example2[Example2["COUNT"] = 100] = "COUNT";
    Example2[Example2["ERROR"] = `Expected ${100 /* COUNT */} items`] = "ERROR";
    return Example2;
  })(Example || {});
  console.log(
    100 /* COUNT */,
    Example.ERROR
  );
  
  // New output (with --tree-shaking=true)
  console.log(
    100 /* COUNT */,
    "Expected 100 items" /* ERROR */
  );

  These rules are not followed exactly due to esbuild's limitations. The rule about dotted references to const variables is not followed both because esbuild's enum processing is done in an isolated module setting and because doing so would potentially require esbuild to use a type system, which it doesn't have. For example:

  // The TypeScript compiler inlines this but esbuild doesn't:
  declare const x = 'foo'
  const enum Foo { X = x }
  console.log(Foo.X)

  Also, the rule that requires converting numbers to a string currently only followed for 32-bit signed integers and non-finite numbers. This is done to avoid accidentally introducing a bug if esbuild's number-to-string operation doesn't exactly match the behavior of a real JavaScript VM. Currently esbuild's number-to-string constant folding is conservative for safety.

• Forbid definite assignment assertion operators on class methods

  In TypeScript, class methods can use the ? optional property operator but not the ! definite assignment assertion operator (while class fields can use both):

  class Foo {
    // These are valid TypeScript
    a?
    b!
    x?() {}
  
    // This is invalid TypeScript
    y!() {}
  }

  Previously esbuild incorrectly allowed the definite assignment assertion operator with class methods. This will no longer be allowed starting with this release.

v0.17.4

Compare Source

• Implement HTTP HEAD requests in serve mode (#​2851)

  Previously esbuild's serve mode only responded to HTTP GET requests. With this release, esbuild's serve mode will also respond to HTTP HEAD requests, which are just like HTTP GET requests except that the body of the response is omitted.

• Permit top-level await in dead code branches (#​2853)

  Adding top-level await to a file has a few consequences with esbuild:

  1. It causes esbuild to assume that the input module format is ESM, since top-level await is only syntactically valid in ESM. That prevents you from using module and exports for exports and also enables strict mode, which disables certain syntax and changes how function hoisting works (among other things).
  2. This will cause esbuild to fail the build if either top-level await isn't supported by your language target (e.g. it's not supported in ES2021) or if top-level await isn't supported by the chosen output format (e.g. it's not supported with CommonJS).
  3. Doing this will prevent you from using require() on this file or on any file that imports this file (even indirectly), since the require() function doesn't return a promise and so can't represent top-level await.

  This release relaxes these rules slightly: rules 2 and 3 will now no longer apply when esbuild has identified the code branch as dead code, such as when it's behind an if (false) check. This should make it possible to use esbuild to convert code into different output formats that only uses top-level await conditionally. This release does not relax rule 1. Top-level await will still cause esbuild to unconditionally consider the input module format to be ESM, even when the top-level await is in a dead code branch. This is necessary because whether the input format is ESM or not affects the whole file, not just the dead code branch.

• Fix entry points where the entire file name is the extension (#​2861)

  Previously if you passed esbuild an entry point where the file extension is the entire file name, esbuild would use the parent directory name to derive the name of the output file. For example, if you passed esbuild a file ./src/.ts then the output name would be src.js. This bug happened because esbuild first strips the file extension to get ./src/ and then joins the path with the working directory to get the absolute path (e.g. join("/working/dir", "./src/") gives /working/dir/src). However, the join operation also canonicalizes the path which strips the trailing /. Later esbuild uses the "base name" operation to extract the name of the output file. Since there is no trailing /, esbuild returns "src" as the base name instead of "", which causes esbuild to incorrectly include the directory name in the output file name. This release fixes this bug by deferring the stripping of the file extension until after all path manipulations have been completed. So now the file ./src/.ts will generate an output file named .js.

• Support replacing property access expressions with inject

  At a high level, this change means the inject feature can now replace all of the same kinds of names as the define feature. So inject is basically now a more powerful version of define, instead of previously only being able to do some of the things that define could do.

  Soem background is necessary to understand this change if you aren't already familiar with the inject feature. The inject feature lets you replace references to global variable with a shim. It works like this:

  1. Put the shim in its own file
  2. Export the shim as the name of the global variable you intend to replace
  3. Pass the file to esbuild using the inject feature

  For example, if you inject the following file using --inject:./injected.js:

  // injected.js
  let processShim = { cwd: () => '/' }
  export { processShim as process }

  Then esbuild will replace all references to process with the processShim variable, which will cause process.cwd() to return '/'. This feature is sort of abusing the ESM export alias syntax to specify the mapping of global variables to shims. But esbuild works this way because using this syntax for that purpose is convenient and terse.

  However, if you wanted to replace a property access expression, the process was more complicated and not as nice. You would have to:

  1. Put the shim in its own file
  2. Export the shim as some random name
  3. Pass the file to esbuild using the inject feature
  4. Use esbuild's define feature to map the property access expression to the random name you made in step 2

  For example, if you inject the following file using --inject:./injected2.js --define:process.cwd=someRandomName:

  // injected2.js
  let cwdShim = () => '/'
  export { cwdShim as someRandomName }

  Then esbuild will replace all references to process.cwd with the cwdShim variable, which will also cause process.cwd() to return '/' (but which this time will not mess with other references to process, which might be desirable).

  With this release, using the inject feature to replace a property access expression is now as simple as using it to replace an identifier. You can now use JavaScript's "arbitrary module namespace identifier names" feature to specify the property access expression directly using a string literal. For example, if you inject the following file using --inject:./injected3.js:

  // injected3.js
  let cwdShim = () => '/'
  export { cwdShim as 'process.cwd' }

  Then esbuild will now replace all references to process.cwd with the cwdShim variable, which will also cause process.cwd() to return '/' (but which will also not mess with other references to process).

  In addition to inserting a shim for a global variable that doesn't exist, another use case is replacing references to static methods on global objects with cached versions to both minify them better and to make access to them potentially faster. For example:

  // Injected file
  let cachedMin = Math.min
  let cachedMax = Math.max
  export {
    cachedMin as 'Math.min',
    cachedMax as 'Math.max',
  }
  
  // Original input
  function clampRGB(r, g, b) {
    return {
      r: Math.max(0, Math.min(1, r)),
      g: Math.max(0, Math.min(1, g)),
      b: Math.max(0, Math.min(1, b)),
    }
  }
  
  // Old output (with --minify)
  function clampRGB(a,t,m){return{r:Math.max(0,Math.min(1,a)),g:Math.max(0,Math.min(1,t)),b:Math.max(0,Math.min(1,m))}}
  
  // New output (with --minify)
  var a=Math.min,t=Math.max;function clampRGB(h,M,m){return{r:t(0,a(1,h)),g:t(0,a(1,M)),b:t(0,a(1,m))}}

v0.17.3

Compare Source

• Fix incorrect CSS minification for certain rules (#​2838)

  Certain rules such as @media could previously be minified incorrectly. Due to a typo in the duplicate rule checker, two known @-rules that share the same hash code were incorrectly considered to be equal. This problem was made worse by the rule hashing code considering two unknown declarations (such as CSS variables) to have the same hash code, which also isn't optimal from a performance perspective. Both of these issues have been fixed:

  /* Original input */
  @​media (prefers-color-scheme: dark) { body { --VAR-1: #​000; } }
  @​media (prefers-color-scheme: dark) { body { --VAR-2: #​000; } }
  
  /* Old output (with --minify) */
  @​media (prefers-color-scheme: dark){body{--VAR-2: #​000}}
  
  /* New output (with --minify) */
  @​media (prefers-color-scheme: dark){body{--VAR-1: #​000}}@​media (prefers-color-scheme: dark){body{--VAR-2: #​000}}

v0.17.2

Compare Source

• Add onDispose to the plugin API (#​2140, #​2205)

  If your plugin wants to perform some cleanup after it's no longer going to be used, you can now use the onDispose API to register a callback for cleanup-related tasks. For example, if a plugin starts a long-running child process then it may want to terminate that process when the plugin is discarded. Previously there was no way to do this. Here's an example:

  let examplePlugin = {
    name: 'example',
    setup(build) {
      build.onDispose(() => {
        console.log('This plugin is no longer used')
      })
    },
  }

  These onDispose callbacks will be called after every build() call regardless of whether the build failed or not as well as after the first dispose() call on a given build context.

v0.17.1

Compare Source

• Make it possible to cancel a build (#​2725)

  The context object introduced in version 0.17.0 has a new cancel() method. You can use it to cancel a long-running build so that you can start a new one without needing to wait for the previous one to finish. When this happens, the previous build should always have at least one error and have no output files (i.e. it will be a failed build).

  Using it might look something like this:

  • JS:

    let ctx = await esbuild.context({
      // ...
    })
    
    let rebuildWithTimeLimit = timeLimit => {
      let timeout = setTimeout(() => ctx.cancel(), timeLimit)
      return ctx.rebuild().finally(() => clearTimeout(timeout))
    }
    
    let build = await rebuildWithTimeLimit(500)

  • Go:

    ctx, err := api.Context(api.BuildOptions{
      // ...
    })
    if err != nil {
      return
    }
    
    rebuildWithTimeLimit := func(timeLimit time.Duration) api.BuildResult {
      t := time.NewTimer(timeLimit)
      go func() {
        <-t.C
        ctx.Cancel()
      }()
      result := ctx.Rebuild()
      t.Stop()
      return result
    }
    
    build := rebuildWithTimeLimit(500 * time.Millisecond)

  This API is a quick implementation and isn't maximally efficient, so the build may continue to do some work for a little bit before stopping. For example, I have added stop points between each top-level phase of the bundler and in the main module graph traversal loop, but I haven't added fine-grained stop points within the internals of the linker. How quickly esbuild stops can be improved in future releases. This means you'll want to wait for cancel() and/or the previous rebuild() to finish (i.e. await the returned promise in JavaScript) before starting a new build, otherwise rebuild() will give you the just-canceled build that still hasn't ended yet. Note that onEnd callbacks will still be run regardless of whether or not the build was canceled.

• Fix server-sent events without servedir (#​2827)

  The server-sent events for live reload were incorrectly using servedir to calculate the path to modified output files. This means events couldn't be sent when servedir wasn't specified. This release uses the internal output directory (which is always present) instead of servedir (which might be omitted), so live reload should now work when servedir is not specified.

• Custom entry point output paths now work with the copy loader (#​2828)

  Entry points can optionally provide custom output paths to change the path of the generated output file. For example, esbuild foo=abc.js bar=xyz.js --outdir=out generates the files out/foo.js and out/bar.js. However, this previously didn't work when using the copy loader due to an oversight. This bug has been fixed. For example, you can now do esbuild foo=abc.html bar=xyz.html --outdir=out --loader:.html=copy to generate the files out/foo.html and out/bar.html.

• The JS API can now take an array of objects (#​2828)

  Previously it was not possible to specify two entry points with the same custom output path using the JS API, although it was possible to do this with the Go API and the CLI. This will not cause a collision if both entry points use different extensions (e.g. if one uses .js and the other uses .css). You can now pass the JS API an array of objects to work around this API limitation:

  // The previous API didn't let you specify duplicate output paths
  let result = await esbuild.build({
    entryPoints: {
      // This object literal contains a duplicate key, so one is ignored
      'dist': 'foo.js',
      'dist': 'bar.css',
    },
  })
  
  // You can now specify duplicate output paths as an array of objects
  let result = await esbuild.build({
    entryPoints: [
      { in: 'foo.js', out: 'dist' },
      { in: 'bar.css', out: 'dist' },
    ],
  })

v0.17.0

Compare Source

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.16.0 or ~0.16.0. See npm's documentation about semver for more information.

At a high level, the breaking changes in this release fix some long-standing issues with the design of esbuild's incremental, watch, and serve APIs. This release also introduces some exciting new features such as live reloading. In detail:

• Move everything related to incremental builds to a new context API (#​1037, #​1606, #​2280, #​2418)

  This change removes the incremental and watch options as well as the serve() method, and introduces a new context() method. The context method takes the same arguments as the build() method but only validates its arguments and does not do an initial build. Instead, builds can be triggered using the rebuild(), watch(), and serve() methods on the returned context object. The new context API looks like this:

  // Create a context for incremental builds
  const context = await esbuild.context({
    entryPoints: ['app.ts'],
    bundle: true,
  })
  
  // Manually do an incremental build
  const result = await context.rebuild()
  
  // Enable watch mode
  await context.watch()
  
  // Enable serve mode
  await context.serve()
  
  // Dispose of the context
  context.dispose()

  The switch to the context API solves a major issue with the previous API which is that if the initial build fails, a promise is thrown in JavaScript which prevents you from accessing the returned result object. That prevented you from setting up long-running operations such as watch mode when the initial build contained errors. It also makes tearing down incremental builds simpler as there is now a single way to do it instead of three separate ways.

  In addition, this release also makes some subtle changes to how incremental builds work. Previously every call to rebuild() started a new build. If you weren't careful, then builds could actually overlap. This doesn't cause any problems with esbuild itself, but could potentially cause problems with plugins (esbuild doesn't even give you a way to identify which overlapping build a given plugin callback is running on). Overlapping builds also arguably aren't useful, or at least aren't useful enough to justify the confusion and complexity that they bring. With this release, there is now only ever a single active build per context. Calling rebuild() before the previous rebuild has finished now "merges" with the existing rebuild instead of starting a new build.

• Allow using watch and serve together (#​805, #​1650, #​2576)

  Previously it was not possible to use watch mode and serve mode together. The rationale was that watch mode is one way of automatically rebuilding your project and serve mode is another (since serve mode automatically rebuilds on every request). However, people want to combine these two features to make "live reloading" where the browser automatically reloads the page when files are changed on the file system.

  This release now allows you to use these two features together. You can only call the watch() and serve() APIs once each per context, but if you call them together on the same context then esbuild will automatically rebuild both when files on the file system are changed and when the server serves a request.

• Support "live reloading" through server-sent events (#​802)

  Server-sent events are a simple way to pass one-directional messages asynchronously from the server to the client. Serve mode now provides a /esbuild endpoint with an change event that triggers every time esbuild's output changes. So you can now implement simple "live reloading" (i.e. reloading the page when a file is edited and saved) like this:

  new EventSource('/esbuild').addEventListener('change', () => location.reload())

  The event payload is a JSON object with the following shape:

  interface ChangeEvent {
    added: string[]
    removed: string[]
    updated: string[]
  }

  This JSON should also enable more complex live reloading scenarios. For example, the following code hot-swaps changed CSS <link> tags in place without reloading the page (but still reloads when there are other types of changes):

  new EventSource('/esbuild').addEventListener('change', e => {
    const { added, removed, updated } = JSON.parse(e.data)
    if (!added.length && !removed.length && updated.length === 1) {
      for (const link of document.getElementsByTagName("link")) {
        const url = new URL(link.href)
        if (url.host === location.host && url.pathname === updated[0]) {
          const next = link.cloneNode()
          next.href = updated[0] + '?' + Math.random().toString(36).slice(2)
          next.onload = () => link.remove()
          link.parentNode.insertBefore(next, link.nextSibling)
          return
        }
      }
    }
    location.reload()
  })

  Implementing live reloading like this has a few known caveats:

  • These events only trigger when esbuild's output changes. They do not trigger when files unrelated to the build being watched are changed. If your HTML file references other files that esbuild doesn't know about and those files are changed, you can either manually reload the page or you can implement your own live reloading infrastructure instead of using esbuild's built-in behavior.

  • The EventSource API is supposed to automatically reconnect for you. However, there's a bug in Firefox that breaks this if the server is ever temporarily unreachable: https://bugzilla.mozilla.org/show_bug.cgi?id=1809332. Workarounds are to use any other browser, to manually reload the page if this happens, or to write more complicated code that manually closes and re-creates the EventSource object if there is a connection error. I'm hopeful that this bug will be fixed.

  • Browser vendors have decided to not implement HTTP/2 without TLS. This means that each /esbuild event source will take up one of your precious 6 simultaneous per-domain HTTP/1.1 connections. So if you open more than six HTTP tabs that use this live-reloading technique, you will be unable to use live reloading in some of those tabs (and other things will likely also break). The workaround is to enable HTTPS, which is now possible to do in esbuild itself (see below).

• Add built-in support for HTTPS (#​2169)

  You can now tell esbuild's built-in development server to use HTTPS instead of HTTP. This is sometimes necessary because browser vendors have started making modern web features unavailable to HTTP websites. Previously you had to put a proxy in front of esbuild to enable HTTPS since esbuild's development server only supported HTTP. But with this release, you can now enable HTTPS with esbuild without an additional proxy.

  To enable HTTPS with esbuild:

  1. Generate a self-signed certificate. There are many ways to do this. Here's one way, assuming you have openssl installed:

     openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 9999 -nodes -subj /CN=127.0.0.1
     

  2. Add --keyfile=key.pem and --certfile=cert.pem to your esbuild development server command

  3. Click past the scary warning in your browser when you load your page

  If you have more complex needs than this, you can still put a proxy in front of esbuild and use that for HTTPS instead. Note that if you see the message "Client sent an HTTP request to an HTTPS server" when you load your page, then you are using the incorrect protocol. Replace http:// with https:// in your browser's URL bar.

  Keep in mind that esbuild's HTTPS support has nothing to do with security. The only reason esbuild now supports HTTPS is because browsers have made it impossible to do local development with certain modern web features without jumping through these extra hoops. Please do not use esbuild's development server for anything that needs to be secure. It's only intended for local development and no considerations have been made for production environments whatsoever.

• Better support copying index.html into the output directory (#​621, #​1771)

  Right now esbuild only supports JavaScript and CSS as first-class content types. Previously this meant that if you were building a website with a HTML file, a JavaScript file, and a CSS file, you could use esbuild to build the JavaScript file and the CSS file into the output directory but not to copy the HTML file into the output directory. You needed a separate cp command for that.

  Or so I thought. It turns out that the copy loader added in version 0.14.44 of esbuild is sufficient to have esbuild copy the HTML file into the output directory as well. You can add something like index.html --loader:.html=copy and esbuild will copy index.html into the output directory for you. The benefits of this are a) you don't need a separate cp command and b) the index.html file will automatically be re-copied when esbuild is in watch mode and the contents of index.html are edited. This also goes for other non-HTML file types that you might want to copy.

  This pretty much already worked. The one thing that didn't work was that esbuild's built-in development server previously only supported implicitly loading index.html (e.g. loading /about/index.html when you visit /about/) when index.html existed on the file system. Previously esbuild didn't support implicitly loading index.html if it was a build result. That bug has been fixed with this release so it should now be practical to use the copy loader to do this.

• Fix onEnd not being called in serve mode (#​1384)

  Previous releases had a bug where plugin onEnd callbacks weren't called when using the top-level serve() API. This API no longer exists and the internals have been reimplemented such that onEnd callbacks should now always be called at the end of every build.

• Incremental builds now write out build results differently (#​2104)

  Previously build results were always written out after every build. However, this could cause the output directory to fill up with files from old builds if code splitting was enabled, since the file names for code splitting chunks contain content hashes and old files were not deleted.

  With this release, incremental builds in esbuild will now delete old output files from previous builds that are no longer relevant. Subsequent incremental builds will also no longer overwrite output files whose contents haven't changed since the previous incremental build.

• The onRebuild watch mode callback was removed (#​980, #​2499)

  Previously watch mode accepted an onRebuild callback which was called whenever watch mode rebuilt something. This was not great in practice because if you are running code after a build, you likely want that code to run after every build, not just after the second and subsequent builds. This release removes option to provide an onRebuild callback. You can create a plugin with an onEnd callback instead. The onEnd plugin API already exists, and is a way to run some code after every build.

• You can now return errors from onEnd (#​2625)

  It's now possible to add additional build errors and/or warnings to the current build from within your onEnd callback by returning them in an array. This is identical to how the onStart callback already works. The evaluation of onEnd callbacks have been moved around a bit internally to make this possible.

  Note that the build will only fail (i.e. reject the promise) if the additional errors are returned from onEnd. Adding additional errors to the result object that's passed to onEnd won't affect esbuild's behavior at all.

• Print URLs and ports from the Go and JS APIs (#​2393)

  Previously esbuild's CLI printed out something like this when serve mode is active:

   > Local:   http://127.0.0.1:8000/
   > Network: http://192.168.0.1:8000/
  

  The CLI still does this, but now the JS and Go serve mode APIs will do this too. This only happens when the log level is set to verbose, debug, or info but not when it's set to warning, error, or silent.

Upgrade guide for existing code:

• Rebuild (a.k.a. incremental build):

  Before:

  const result = await esbuild.build({ ...buildOptions, incremental: true });
  builds.push(result);
  for (let i = 0; i < 4; i++) builds.push(await result.rebuild());
  await result.rebuild.dispose(); // To free resources

  After:

  const ctx = await esbuild.context(buildOptions);
  for (let i = 0; i < 5; i++) builds.push(await ctx.rebuild());
  await ctx.dispose(); // To free resources

  Previously the first build was done differently than subsequent builds. Now both the first build and subsequent builds are done using the same API.

• Serve:

  Before:

  const serveResult = await esbuild.serve(serveOptions, buildOptions);
  ...
  serveResult.stop(); await serveResult.wait; // To free resources

  After:

  const ctx = await esbuild.context(buildOptions);
  const serveResult = await ctx.serve(serveOptions);
  ...
  await ctx.dispose(); // To free resources

• Watch:

  Before:

  const result = await esbuild.build({ ...buildOptions, watch: true });
  ...
  result.stop(); // To free resources

  After:

  const ctx = await esbuild.context(buildOptions);
  await ctx.watch();
  ...
  await ctx.dispose(); // To free resources

• Watch with onRebuild:

  Before:

  const onRebuild = (error, result) => {
    if (error) console.log('subsequent build:', error);
    else console.log('subsequent build:', result);
  };
  try {
    const result = await esbuild.build({ ...buildOptions, watch: { onRebuild } });
    console.log('first build:', result);
    ...
    result.stop(); // To free resources
  } catch (error) {
    console.log('first build:', error);
  }

  After:

  const plugins = [{
    name: 'my-plugin',
    setup(build) {
      let count = 0;
      build.onEnd(result => {
        if (count++ === 0) console.log('first build:', result);
        else console.log('subsequent build:', result);
      });
    },
  }];
  const ctx = await esbuild.context({ ...buildOptions, plugins });
  await ctx.watch();
  ...
  await ctx.dispose(); // To free resources

  The onRebuild function has now been removed. The replacement is to make a plugin with an onEnd callback.

  Previously onRebuild did not fire for the first build (only for subsequent builds). This was usually problematic, so using onEnd instead of onRebuild is likely less error-prone. But if you need to emulate the old behavior of onRebuild that ignores the first build, then you'll need to manually count and ignore the first build in your plugin (as demonstrated above).

Notice how all of these API calls are now done off the new context object. You should now be able to use all three kinds of incremental builds (rebuild, serve, and watch) together on the same context object. Also notice how calling dispose on the context is now the common way to discard the context and free resources in all of these situations.

v0.16.17

Compare Source

• Fix additional comment-related regressions (#​2814)

  This release fixes more edge cases where the new comment preservation behavior that was added in 0.16.14 could introduce syntax errors. Specifically:

  x = () => (/* comment */ {})
  for ((/* comment */ let).x of y) ;
  function *f() { yield (/* comment */class {}) }

  These cases caused esbuild to generate code with a syntax error in version 0.16.14 or above. These bugs have now been fixed.

v0.16.16

Compare Source

• Fix a regression caused by comment preservation (#​2805)

  The new comment preservation behavior that was added in 0.16.14 introduced a regression where comments in certain locations could cause esbuild to omit certain necessary parentheses in the output. The outermost parentheses were incorrectly removed for the following syntax forms, which then introduced syntax errors:

  (/* comment */ { x: 0 }).x;
  (/* comment */ function () { })();
  (/* comment */ class { }).prototype;

  This regression has been fixed.

v0.16.15

Compare Source

• Add format to input files in the JSON metafile data

  When --metafile is enabled, input files may now have an additional format field that indicates the export format used by this file. When present, the value will either be cjs for CommonJS-style exports or esm for ESM-style exports. This can be useful in bundle analysis.

  For example, esbuild's new Bundle Size Analyzer now uses this information to visualize whether ESM or CommonJS was used for each directory and file of source code (click on the CJS/ESM bar at the top).

  This information is helpful when trying to reduce the size of your bundle. Using the ESM variant of a dependency instead of the CommonJS variant always results in a faster and smaller bundle because it omits CommonJS wrappers, and also may result in better tree-shaking as it allows esbuild to perform tree-shaking at the statement level instead of the module level.

• Fix a bundling edge case with dynamic import (#​2793)

  This release fixes a bug where esbuild's bundler could produce incorrect output. The problematic edge case involves the entry point importing itself using a dynamic import() expression in an imported file, like this:

  // src/a.js
  export const A = 42;
  
  // src/b.js
  export const B = async () => (await import(".")).A
  
  // src/index.js
  export * from "./a"
  export * from "./b"

• Remove new type syntax from type declarations in the esbuild package (#​2798)

  Previously you needed to use TypeScript 4.3 or newer when using the esbuild package from TypeScript code due to the use of a getter in an interface in node_modules/esbuild/lib/main.d.ts. This release removes this newer syntax to allow people with versions of TypeScript as far back as TypeScript 3.5 to use this latest version of the esbuild package. Here is change that was made to esbuild's type declarations:

   export interface OutputFile {
     /** "text" as bytes */
     contents: Uint8Array;
     /** "contents" as text (changes automatically with "contents") */
  -  get text(): string;
  +  readonly text: string;
   }

---

Configuration

📅 Schedule: Branch creation - "before 7am on Tuesday,before 7am on Wednesday" in timezone Australia/Sydney, 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.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated
keystone-next-docs	⬜️ Ignored (Inspect)	Visit Preview		Feb 20, 2023 at 2:23AM (UTC)

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0905931

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 0905931:

Sandbox	Source
@keystone-6/sandbox	Configuration

[renovate]

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.
You can manually request rebase by checking the rebase/retry box above.

⚠ Warning: custom changes will be lost.