bun.sh/docs/bundler/macros.md

Macros are a mechanism for running JavaScript functions at bundle-time. The value returned from these functions are directly inlined into your bundle.

As a toy example, consider this simple function that returns a random number.

export function random() {
  return Math.random();
}

This is just a regular function in a regular file, but we can use it as a macro like so:

import { random } from './random.ts' with { type: 'macro' };

console.log(`Your random number is ${random()}`);

{% callout %} Note — Macros are indicated using import attribute syntax. If you haven't seen this syntax before, it's a Stage 3 TC39 proposal that lets you attach additional metadata to import statements. {% /callout %}

Now we'll bundle this file with bun build. The bundled file will be printed to stdout.

$ bun build ./cli.tsx
console.log(`Your random number is ${0.6805550949689833}`);

As you can see, the source code of the random function occurs nowhere in the bundle. Instead, it is executed during bundling and function call (random()) is replaced with the result of the function.

When to use macros

If you have several build scripts for For small things where you would otherwise have a one-off build script, bundle-time code execution can be easier to maintain. It lives with the rest of your code, it runs with the rest of the build, it is automatically paralellized, and if it fails, the build fails too.

If you find yourself running a lot of code at bundle-time though, consider running a server instead.

Import attributes

Bun Macros are import statements annotated using either:

• with { type: 'macro' } — an import attribute, a Stage 3 ECMA Scrd
• assert { type: 'macro' } — an import assertion, an earlier incarnation of import attributes that has now been abandoned (but is already supported by a number of browsers and runtimes)

Execution

When Bun's transpiler sees a macro import, it calls the function inside the transpiler using Bun's JavaScript runtime and converts the return value from JavaScript into an AST node. These JavaScript functions are called at bundle-time, not runtime.

Macros are executed synchronously in the transpiler during the visiting phase—before plugins and before the transpiler generates the AST. They are executed in the order they are imported. The transpiler will wait for the macro to finish executing before continuing. The transpiler will also await any Promise returned by a macro.

Bun's bundler is multi-threaded. As such, macros execute in parallel inside of multiple spawned JavaScript "workers".

Dead code elimination

The bundler performs dead code elimination after running and inlining macros. So given the following macro:

export function returnFalse() {
  return false;
}

...then bundling the following file will produce an empty bundle.

import {returnFalse} from './returnFalse.ts' with { type: 'macro' };

if (returnFalse()) {
  console.log("This code is eliminated");
}

console.log(obj.foo);

Security

Macros are only executed on your source files, not on files imported from packages in node_modules.

The source code of a macro will never be included in the bundled; as such, macros can safely perform privileged operations like reading from a database.

Serializablility

Bun's transpiler needs to be able to serialize the result of the macro so it can be inlined into the AST. All JSON-compatible data structures are supported:

export function getObject() {
  return {
    foo: "bar",
    baz: 123,
    array: [ 1, 2, { nested: "value" }],
  };
}

Macros can be async, or return Promise instances. Bun's transpiler will automatically await the Promise and inline the result.

export async function getText() {
  return "async value";
}

The transpiler implements specicial logic for serializing common data formats like Response, Blob, TypedArray.

• TypedArray: Resolves to a base64-encoded string.
• Response: Where relevant, Bun will read the Content-Type and serialize accordingly; for instance, a Response with type application/json will be automatically parsed into an object. Otherwise, it will be resolved with resp.text().
• Blob: As with Response, the serialization depends on the type property.

The result of fetch is Promise<Response>, so it can be directly returned.

export function getObject() {
  return fetch("https://bun.sh")
}

Functions and instances of most classes (except those mentioned above) are not serializable.

export function getText(url: string) {
  // this doesn't work!
  return () => {};
}

Arguments

Macros can accept inputs, but only in limited cases. The value must be statically known. For example, the following is not allowed:

import {getText} from './getText.ts' with { type: 'macro' };

export function howLong() {
  // the value of `foo` cannot be statically known
  const foo = Math.random() ? "foo" : "bar";

  const text = getText(`https://example.com/${foo}`);
  console.log("The page is ", text.length, " characters long");
}

However, if the value of foo is known at bundle-time (say, if it's a constant or the result of another macro) then it's allowed:

import {getText} from './getText.ts' with { type: 'macro' };
import {getFoo} from './getFoo.ts' with { type: 'macro' };

export function howLong() {
  // this works because getFoo() is statically known
  const foo = getFoo();
  const text = getText(`https://example.com/${foo}`);
  console.log("The page is", text.length, "characters long");
}

This outputs:

function howLong() {
  console.log("The page is", 1322, "characters long");
}
export { howLong };

Examples

Embed latest git commit hash

{% codetabs %}

export function getGitCommitHash() {
  const {stdout} = Bun.spawnSync({
    cmd: ["git", "rev-parse", "HEAD"],
    stdout: "pipe",
  });

  return stdout.toString();
}

{% /codetabs %}

When we build it, the getGitCommitHash is replaced with the result of calling the function:

{% codetabs %}

import { getGitCommitHash } from './getGitCommitHash.ts' with { type: 'macro' };

console.log(`The current Git commit hash is ${getGitCommitHash()}`);

console.log(`The current Git commit hash is 3ee3259104f`);

{% /codetabs %}

You're probably thinking "Why not just use process.env.GIT_COMMIT_HASH?" Well, you can do that too. But can you do this with an environment variable?

Make fetch() requests at bundle-time

In this example, we make an outgoing HTTP request using fetch(), parse the HTML response using HTMLRewriter, and return an object containing the title and meta tags–all at bundle-time.

export async function extractMetaTags(url: string) {
  const response = await fetch(url);
  const meta = {
    title: "",
  };
  new HTMLRewriter()
    .on("title", {
      text(element) {
        meta.title += element.text;
      },
    })
    .on("meta", {
      element(element) {
        const name =
          element.getAttribute("name") || element.getAttribute("property") || element.getAttribute("itemprop");

        if (name) meta[name] = element.getAttribute("content");
      },
    })
    .transform(response);

  return meta;
}

The extractMetaTags function is erased at bundle-time and replaced with the result of the function call. This means that the fetch request happens at bundle-time, and the result is embedded in the bundle. Also, the branch throwing the error is eliminated since it's unreachable.

{% codetabs %}

import { extractMetaTags } from './meta.ts' with { type: 'macro' };

export const Head = () => {
  const headTags = extractMetaTags("https://example.com");

  if (headTags.title !== "Example Domain") {
    throw new Error("Expected title to be 'Example Domain'");
  }

  return <head>
    <title>{headTags.title}</title>
    <meta name="viewport" content={headTags.viewport} />
  </head>;
};

import { jsx, jsxs } from "react/jsx-runtime";
export const Head = () => {
  jsxs("head", {
    children: [
      jsx("title", {
        children: "Example Domain",
      }),
      jsx("meta", {
        name: "viewport",
        content: "width=device-width, initial-scale=1",
      }),
    ],
  });
};

export { Head };

{% /codetabs %}