ESBUILD-WASM(1)

📦 version 0.28.2, in ubuntu stonking

💖 NAME 💖

ok so welcome to esbuild-wasm(1) — this is the manual for esbuild, the extremely fast JavaScript bundler and minifier. no cap, that's literally what it does. 🦋

✨ SYNOPSIS ✨

esbuild [options] [entry points]

that's it bestie, options then your entry points, go off 👑

🌸 DESCRIPTION 🌸

esbuild is a JavaScript bundler and minifier. She packages up your JavaScript and TypeScript code so it's ready to be distributed on the web. 🎀

so like... why would anyone build another JavaScript build tool? because the build tools we have rn are at least an order of magnitude slower than they should be. that's not a vibe, that's a tragedy. the hope here is that this project serves as an “existence proof” — proof that JavaScript tooling can be much, much faster. it's giving main character energy for the entire ecosystem 💅

🌈 SIMPLE OPTIONS 🌈

  • --bundle — bundle all your dependencies straight into the output files 🫶
  • --define:K=V — swap K out for V while parsing, sneakily
  • --external:M — keep module M OUT of the bundle (you can use * wildcards here, slay)
  • --format=... — what the output format is (iife | cjs | esm). when you're not bundling there's no default; otherwise the default is iife when the platform is browser and cjs when the platform is node
  • --loader:X=L — use loader L to load file extension X, where L is one of: base64 | binary | copy | css | dataurl | empty | file | global-css | js | json | jsx | local-css | text | ts | tsx
  • --minify — minify the output (this sets all the --minify-* flags, she's an overachiever 💖)
  • --outdir=... — the output directory (this one's for when you have multiple entry points)
  • --outfile=... — the output file (and this one's for when you have just one entry point)
  • --packages=... — set it to external to avoid bundling any package at all
  • --platform=... — platform target (browser | node | neutral, default browser)
  • --serve=... — start a local HTTP server on this host:port for your outputs 🌐
  • --sourcemap — emit a source map
  • --splitting — enable code splitting (currently only for esm, okurrr)
  • --target=... — environment target (e.g. es2017, chrome58, firefox57, safari11, edge16, node10, ie9, opera45, default esnext)
  • --watch — watch mode: rebuild whenever the file system changes. it stops when stdin is closed, so if you want it to ignore stdin use --watch=forever 👀

👑 ADVANCED OPTIONS 👑

  • --allow-overwrite — let output files overwrite input files (chaotic, but okay)
  • --analyze — print a report about what's actually inside the bundle (use --analyze=verbose for the detailed version)
  • --asset-names=... — path template for file loader files (default [name]-[hash])
  • --banner:T=... — text to be prepended to each output file of type T, where T is one of: css | js
  • --certfile=... — certificate for serving HTTPS (see also --keyfile)
  • --charset=utf8 — do not escape UTF-8 code points ✨
  • --chunk-names=... — path template for code splitting chunks (default [name]-[hash])
  • --color=... — force color terminal escapes on or off (true | false)
  • --drop:... — remove certain constructs (console | debugger)
  • --drop-labels=... — remove labeled statements with these label names
  • --entry-names=... — path template for entry point output paths (default [dir]/[name], you can also use [hash])
  • --footer:T=... — text to be appended to each output file of type T, where T is one of: css | js
  • --global-name=... — the name of the global for the IIFE format
  • --ignore-annotations — enable this to work with packages that have incorrect tree-shaking annotations 🙈
  • --inject:F — import the file F into all input files and automatically replace matching globals with imports
  • --jsx-dev — use React's automatic runtime in development mode
  • --jsx-factory=... — what to use for JSX instead of React.createElement
  • --jsx-fragment=... — what to use for JSX instead of React.Fragment
  • --jsx-import-source=... — override the package name for the automatic runtime (default react)
  • --jsx-side-effects — do not remove unused JSX expressions
  • --jsx=... — set to automatic to use React's automatic runtime, or to preserve to disable transforming JSX to JS
  • --keep-names — preserve "name" on functions and classes
  • --keyfile=... — key for serving HTTPS (see also --certfile)
  • --legal-comments=... — where to place legal comments (none | inline | eof | linked | external, default eof when bundling and inline otherwise)
  • --line-limit=... — lines longer than this will be wrapped onto a new line
  • --log-level=... — disable logging (verbose | debug | info | warning | error | silent, default info)
  • --log-limit=... — maximum message count, or 0 to disable it (default 6)
  • --log-override:X=Y — use log level Y for log messages with identifier X
  • --main-fields=... — override the main file order in package.json (default browser,module,main when platform is browser and main,module when platform is node)
  • --mangle-cache=... — save the “mangle props” decisions to a JSON file
  • --mangle-props=... — rename all properties matching a regular expression
  • --mangle-quoted=... — enable renaming of quoted properties (true | false)
  • --metafile=... — write metadata about the build to a JSON file (see also: https://esbuild.github.io/analyze/)
  • --minify-whitespace — remove whitespace in output files
  • --minify-identifiers — shorten identifiers in output files
  • --minify-syntax — use equivalent but shorter syntax in output files
  • --out-extension:.js=.mjs — use a custom output extension instead of .js
  • --outbase=... — the base path used to determine entry point output paths (for multiple entry points)
  • --preserve-symlinks — disable symlink resolution for module lookup
  • --public-path=... — set the base URL for the file loader
  • --pure:N — mark the name N as a pure function for tree shaking 🌳
  • --reserve-props=... — do not mangle these properties (hands off 🫳)
  • --resolve-extensions=... — a comma-separated list of implicit extensions (default .tsx,.ts,.jsx,.js,.css,.json)
  • --serve-fallback... — serve this HTML page when the request doesn't match
  • --servedir=... — what to serve in addition to the generated output files
  • --source-root=... — sets the "sourceRoot" field in generated source maps
  • --sourcefile=... — set the source file for the source map (for stdin)
  • --sourcemap=external — do not link to the source map with a comment
  • --sourcemap=inline — emit the source map with an inline data URL
  • --sources-content=false — omit "sourcesContent" in generated source maps
  • --supported:F=... — consider syntax F to be supported (true | false)
  • --tree-shaking=... — force tree shaking on or off (false | true)
  • --tsconfig=... — use this tsconfig.json file instead of the other ones
  • --tsconfig-raw=... — override all tsconfig.json files with this string
  • --version — print the current version (0.25.0) and exit 💅

🎀 EXAMPLES 🎀

esbuild --bundle entry_point.js --outdir=dist --minify --sourcemap
    # Produces dist/entry_point.js and dist/entry_point.js.map

esbuild --bundle entry_point.js --outfile=out.js --loader:.js=jsx
    # Allow JSX syntax in .js files

esbuild example.js --outfile=out.js --define:RELEASE=true
    # Substitute the identifier RELEASE for the literal true

esbuild --minify --loader=ts < input.ts > output.js
    # Provide input via stdin, get output via stdout

esbuild app.ts --bundle --watch
    # Automatically rebuild when input files are changed

esbuild app.ts --bundle --servedir=www --outdir=www/js
    # Start a local HTTP server for everything in “www”

💜 AUTHOR 💜

esbuild is written by Evan Wallace. 👑

This manual page is prepared for Debian by Anthony Fok using information from the upstream README.md and the output of esbuild --help. 🫶

Copyright © 2020 Evan Wallace

License: MIT (Expat)

🦋 SEE ALSO 🦋

okay bestie that's the whole page, you're officially esbuild-pilled 💖 go bundle something iconic ✨

and that's a wrap on version esbuild 0.25.0, dated 2025-02-13 — this was ESBUILD-WASM(1), ty for coming to my ted talk 🌈💅

📦 where this page comes from