[js] Update esbuild: 0.16.9 → 0.16.17 (minor)

[depfu]

---

Welcome to Depfu 👋

This is one of the first three pull requests with dependency updates we've sent your way. We tried to start with a few easy patch-level updates. Hopefully your tests will pass and you can merge this pull request without too much risk. This should give you an idea how Depfu works in general.

After you merge your first pull request, we'll send you a few more. We'll never open more than seven PRs at the same time so you're not getting overwhelmed with updates.

Let us know if you have any questions. Thanks so much for giving Depfu a try!

---

Here is everything you need to know about this update. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ esbuild (0.16.9 → 0.16.17) · Repo · Changelog

Release Notes

0.16.17

• 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.

0.16.16

• 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.

0.16.15

• 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;
   }

0.16.14

• Preserve some comments in expressions (#2721)

  Various tools give semantic meaning to comments embedded inside of expressions. For example, Webpack and Vite have special "magic comments" that can be used to affect code splitting behavior:

  import(/* webpackChunkName: "foo" */ '../foo');
  import(/* @vite-ignore */ dynamicVar);
  new Worker(/* webpackChunkName: "bar" */ new URL("../bar.ts", import.meta.url));
  new Worker(new URL('./path', import.meta.url), /* @vite-ignore */ dynamicOptions);

  Since esbuild can be used as a preprocessor for these tools (e.g. to strip TypeScript types), it can be problematic if esbuild doesn't do additional work to try to retain these comments. Previously esbuild special-cased Webpack comments in these specific locations in the AST. But Vite would now like to use similar comments, and likely other tools as well.

  So with this release, esbuild now will attempt to preserve some comments inside of expressions in more situations than before. This behavior is mainly intended to preserve these special "magic comments" that are meant for other tools to consume, although esbuild will no longer only preserve Webpack-specific comments so it should now be tool-agnostic. There is no guarantee that all such comments will be preserved (especially when --minify-syntax is enabled). So this change does not mean that esbuild is now usable as a code formatter. In particular comment preservation is more likely to happen with leading comments than with trailing comments. You should put comments that you want to be preserved before the relevant expression instead of after it. Also note that this change does not retain any more statement-level comments than before (i.e. comments not embedded inside of expressions). Comment preservation is not enabled when --minify-whitespace is enabled (which is automatically enabled when you use --minify).

0.16.13

• Publish a new bundle visualization tool

  While esbuild provides bundle metadata via the --metafile flag, previously esbuild left analysis of it completely up to third-party tools (well, outside of the rudimentary --analyze flag). However, the esbuild website now has a built-in bundle visualization tool:

  • https://esbuild.github.io/analyze/

  You can pass --metafile to esbuild to output bundle metadata, then upload that JSON file to this tool to visualize your bundle. This is helpful for answering questions such as:

  • Which packages are included in my bundle?
  • How did a specific file get included?
  • How small did a specific file compress to?
  • Was a specific file tree-shaken or not?

  I'm publishing this tool because I think esbuild should provide some answer to "how do I visualize my bundle" without requiring people to reach for third-party tools. At the moment the tool offers two types of visualizations: a radial "sunburst chart" and a linear "flame chart". They serve slightly different but overlapping use cases (e.g. the sunburst chart is more keyboard-accessible while the flame chart is easier with the mouse). This tool may continue to evolve over time.

• Fix --metafile and --mangle-cache with --watch (#1357)

  The CLI calls the Go API and then also writes out the metafile and/or mangle cache JSON files if those features are enabled. This extra step is necessary because these files are returned by the Go API as in-memory strings. However, this extra step accidentally didn't happen for all builds after the initial build when watch mode was enabled. This behavior used to work but it was broken in version 0.14.18 by the introduction of the mangle cache feature. This release fixes the combination of these features, so the metafile and mangle cache features should now work with watch mode. This behavior was only broken for the CLI, not for the JS or Go APIs.

• Add an original field to the metafile

  The metadata file JSON now has an additional field: each import in an input file now contains the pre-resolved path in the original field in addition to the post-resolved path in the path field. This means it's now possible to run certain additional analysis over your bundle. For example, you should be able to use this to detect when the same package subpath is represented multiple times in the bundle, either because multiple versions of a package were bundled or because a package is experiencing the dual-package hazard.

0.16.12

• Loader defaults to js for extensionless files (#2776)

  Certain packages contain files without an extension. For example, the yargs package contains the file yargs/yargs which has no extension. Node, Webpack, and Parcel can all understand code that imports yargs/yargs because they assume that the file is JavaScript. However, esbuild was previously unable to understand this code because it relies on the file extension to tell it how to interpret the file. With this release, esbuild will now assume files without an extension are JavaScript files. This can be customized by setting the loader for "" (the empty string, representing files without an extension) to another loader. For example, if you want files without an extension to be treated as CSS instead, you can do that like this:

  • CLI:

    esbuild --bundle --loader:=css
    

  • JS:

    esbuild.build({
      bundle: true,
      loader: { '': 'css' },
    })

  • Go:

    api.Build(api.BuildOptions{
      Bundle: true,
      Loader: map[string]api.Loader{"": api.LoaderCSS},
    })

  In addition, the "type" field in package.json files now only applies to files with an explicit .js, .jsx, .ts, or .tsx extension. Previously it was incorrectly applied by esbuild to all files that had an extension other than .mjs, .mts, .cjs, or .cts including extensionless files. So for example an extensionless file in a "type": "module" package is now treated as CommonJS instead of ESM.

0.16.11

• Avoid a syntax error in the presence of direct eval (#2761)

  The behavior of nested function declarations in JavaScript depends on whether the code is run in strict mode or not. It would be problematic if esbuild preserved nested function declarations in its output because then the behavior would depend on whether the output was run in strict mode or not instead of respecting the strict mode behavior of the original source code. To avoid this, esbuild transforms nested function declarations to preserve the intended behavior of the original source code regardless of whether the output is run in strict mode or not:

  // Original code
  if (true) {
    function foo() {}
    console.log(!!foo)
    foo = null
    console.log(!!foo)
  }
  console.log(!!foo)
  // Transformed code
  if (true) {
  let foo2 = function() {
  };
  var foo = foo2;
  console.log(!!foo2);
  foo2 = null;
  console.log(!!foo2);
  }
  console.log(!!foo);

  In the above example, the original code should print true false true because it's not run in strict mode (it doesn't contain "use strict" and is not an ES module). The code that esbuild generates has been transformed such that it prints true false true regardless of whether it's run in strict mode or not.

  However, this transformation is impossible if the code contains direct eval because direct eval "poisons" all containing scopes by preventing anything in those scopes from being renamed. That prevents esbuild from splitting up accesses to foo into two separate variables with different names. Previously esbuild still did this transformation but with two variables both named foo, which is a syntax error. With this release esbuild will now skip doing this transformation when direct eval is present to avoid generating code with a syntax error. This means that the generated code may no longer behave as intended since the behavior depends on the run-time strict mode setting instead of the strict mode setting present in the original source code. To fix this problem, you will need to remove the use of direct eval.

• Fix a bundling scenario involving multiple symlinks (#2773, #2774)

  This release contains a fix for a bundling scenario involving an import path where multiple path segments are symlinks. Previously esbuild was unable to resolve certain import paths in this scenario, but these import paths should now work starting with this release. This fix was contributed by @onebytegone.

0.16.10

• Change the default "legal comment" behavior again (#2745)

  The legal comments feature automatically gathers comments containing @license or @preserve and puts the comments somewhere (either in the generated code or in a separate file). This behavior used to be on by default but was disabled by default in version 0.16.0 because automatically inserting comments is potentially confusing and misleading. These comments can appear to be assigning the copyright of your code to another entity. And this behavior can be especially problematic if it happens automatically by default since you may not even be aware of it happening. For example, if you bundle the TypeScript compiler the preserving legal comments means your source code would contain this comment, which appears to be assigning the copyright of all of your code to Microsoft:

  /*! *****************************************************************************
  Copyright (c) Microsoft Corporation. All rights reserved.
  Licensed under the Apache License, Version 2.0 (the "License"); you may not use
  this file except in compliance with the License. You may obtain a copy of the
  License at http://www.apache.org/licenses/LICENSE-2.0
  
  THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
  WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
  MERCHANTABLITY OR NON-INFRINGEMENT.
  
  See the Apache Version 2.0 License for specific language governing permissions
  and limitations under the License.
  ***************************************************************************** */

  However, people have asked for this feature to be re-enabled by default. To resolve the confusion about what these comments are applying to, esbuild's default behavior will now be to attempt to describe which package the comments are coming from. So while this feature has been re-enabled by default, the output will now look something like this instead:

  /*! Bundled license information:
  
  typescript/lib/typescript.js:
    (*! *****************************************************************************
    Copyright (c) Microsoft Corporation. All rights reserved.
    Licensed under the Apache License, Version 2.0 (the "License"); you may not use
    this file except in compliance with the License. You may obtain a copy of the
    License at http://www.apache.org/licenses/LICENSE-2.0
  
    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
    WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
    MERCHANTABLITY OR NON-INFRINGEMENT.
  
    See the Apache Version 2.0 License for specific language governing permissions
    and limitations under the License.
    ***************************************************************************** *)
  */

  Note that you can still customize this behavior with the --legal-comments= flag. For example, you can use --legal-comments=none to turn this off, or you can use --legal-comments=linked to put these comments in a separate .LEGAL.txt file instead.

• Enable external legal comments with the transform API (#2390)

  Previously esbuild's transform API only supported none, inline, or eof legal comments. With this release, external legal comments are now also supported with the transform API. This only applies to the JS and Go APIs, not to the CLI, and looks like this:

  • JS:

    const { code, legalComments } = await esbuild.transform(input, {
      legalComments: 'external',
    })

  • Go:

    result := api.Transform(input, api.TransformOptions{
      LegalComments: api.LegalCommentsEndOfFile,
    })
    code := result.Code
    legalComments := result.LegalComments

• Fix duplicate function declaration edge cases (#2757)

  The change in the previous release to forbid duplicate function declarations in certain cases accidentally forbid some edge cases that should have been allowed. Specifically duplicate function declarations are forbidden in nested blocks in strict mode and at the top level of modules, but are allowed when they are declared at the top level of function bodies. This release fixes the regression by re-allowing the last case.

• Allow package subpaths with alias (#2715)

  Previously the names passed to the alias feature had to be the name of a package (with or without a package scope). With this release, you can now also use the alias feature with package subpaths. So for example you can now create an alias that substitutes @org/pkg/lib with something else.

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 56 commits:

• publish 0.16.17 to npm
• fix #2814: additional comment-related regressions
• workaround for #2785 and #2812
• publish 0.16.16 to npm
• fix #2805: parentheses for commented expressions
• only register plugin callbacks if needed
• publish 0.16.15 to npm
• fix #2798: make type declarations work in TS v3.5+
• fix #2793: bundling edge case with dynamic import
• add `"format"` to inputs in metafile
• `JSON.parse` + `JSON.stringify`: no side effects
• publish 0.16.14 to npm
• preserve comments in import assertions too
• fix #2721: make comment-preservation more general
• change `LegalCommentsBeforeToken` into ranges
• parser recovery for `??` with `||` and/or `&&`
• more error text for #2790
• link to analyzer in help text
• publish 0.16.13 to npm
• mention the bundle analyzer in the release notes
• add the `original` field to the metafile
• feat: add markdown to guessed mime types (#2784)
• add a custom error message for #2783
• enable source maps for the json loader
• fix test flake in `watchMetafile`
• always use a plugin for post-build actions
• watch mode: print metafile analysis after rebuilds
• test coverage for: Cannot use "watch" with "serve"
• some tests don't need
• fix #1357: `watch` + `metafile`/`mangle-cache`
• test coverage: js, watch, metafile, mangle cache
• fix option validation logs with cli in serve mode
• serve no longer keeps options object alive
• separate out build options validation
• introduce `rebuildArgs`
• don't record duplicate legal comments in same file
• remove `PrettyPath` from resolver
• add some more comments
• move watcher to separate file
• publish 0.16.12 to npm
• limit `type` in package.json to `.js` and friends
• fix #2776: assume extensionless files are js
• allow loaders for extensionless files
• publish 0.16.11 to npm
• fix #2773: eval dependency symlinks instead of reading symlink target (#2774)
• Fix typo in js_parser_lower.go (#2771)
• additional test coverage
• fix #2761: avoid syntax error with direct `eval`
• explicit pre-release version error (#2766, #2760)
• publish 0.16.10 to npm
• fix #2715: allow package subpaths with `alias`
• fix #2390: transform w/ `external` legal comments
• fix #2757: duplicate function definition edge case
• option to not escape `</script>` and `</style>`
• fix #2745: another change to legal comments
• fix default wasm name for deno to `esbuild.wasm`

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)