Stub your build and never watch & rebuild ever again.

Getting Started  |  Documentation  |  Developer API

Why?

❌ The watch & rebuild problem

When working with workspaces (ie multiple packages in a repository) even though you link a package from your local file system, the module resolution still depends on your package.json exports/main which usually points to the code's bundled directory (eg dist/, build/, lib/, etc).

This way you still need the source code to be bundled so that some other package can consume it, even locally. The most common way to get around this inconvenience is with watch & rebuild, triggering the build when some source file changes. You will need a background process to watch the file changes and might experience some delay to changes be applied (including the types that depends on build .d.ts)

✔ The stubbing solution

The ideia is to create a different build output on development that works like a bridge between your package.json exports/main resolution and your source file.

👉 Getting started

Note

ts-stub is made to be used in workspaces/multi-package repos (aka monorepos).
Otherwise it will not bring any benefit, unless you do manual symlinks through your local repos.

TL;DR
Add { "stub": "ts-stub --clear" } script to all packages and execute all at once.

1 Install ts-stub with your package manager

pnpm add -D ts-stub
# npm install --save-dev ts-stub

2 Add a separate build script to stubbing your packages

packages/a/package.json

{
  "name": "package-a",
  "scripts": {
    "build": "tsup",
+   "stub": "ts-stub --clear"
  }
}

packages/b/package.json

{
  "name": "package-b",
  "scripts": {
    "build": "tsup",
+   "stub": "ts-stub --clear"
  }
}

3 Stub all at once

Use your favorite tool to execute all packages stub script (like pnpm -r, turbo, lerna, nx, etc.)

pnpm -r stub

packages/a stub$ ts-stub --clear
│ ✓ Cleaned …my-monorepo/packages/a/dist
│ ✓ Stubbed …e/packages/a/dist/index.mjs
│ ✓ Stubbed …/packages/a/dist/index.d.ts
└─ Done in 242ms
packages/b stub$ ts-stub --clear
│ ✓ Cleaned …my-monorepo/packages/b/dist
│ ✓ Stubbed …e/packages/b/dist/index.mjs
│ ✓ Stubbed …/packages/b/dist/index.d.ts
└─ Done in 233ms

📖 Documentation

By default ts-stub will use src/index.ts as entrypoint and dist as your build folder.
But everyting is configurable!

Input and output files:

ts-stub --input=src/foo.ts --output=build

Output format:

ts-stub --format=cjs

Output format extension:

ts-stub --format=cjs:js

Custom working directory:

ts-stub packages/foo
# same as: ts-stub --input=packages/foo/src/index.ts --output=packages/foo/dist

Options

You can run ts-stub --help to see the following available options:

Usage: ts-stub [options] [cwd_directory]

Stub your build to improve monorepo DX

Options:
  -V, --version          output the version number
  -i, --input [file]     Input typescript file path (default: "src/index.ts")
  -o, --output [dir]     Output stub directory (default: "dist")
  --noEmit               Disable emitting declaration files (default: false)
  -f, --format [format]  Output format and extension. Can be "esm", "esm:js", "cjs" and "cjs:js"
                         Default extension for "esm" and "cjs" are ".mjs" and ".cjs"
  -c, --clear            Clear output folder before stubbing (default: false)
  -q, --quiet            Prevent any output to stdout (default: false)
  --noEffects            Disable any file system mutations (default: false)
  -h, --help             display help for command

📃 Developer API

Single entry:

import { stub } from "ts-stub";

stub({
  entry: {
    input: "src/index.ts",
    output: "dist",
    format: "esm",
  },
  cwd: path.join(process.cwd(), "/path/to/package"),
  quiet: false, // default false
  clear: true, // default false
  noEffects: false, // default false
});

Multiple entries:

import { stub } from "ts-stub";

stub({
  entry: [
    {
      input: "src/index.ts",
      output: "dist",
      format: "esm",
    },
    {
      input: "src/server.ts",
      output: "dist",
      format: "esm",
    },
  ],
  cwd: path.join(process.cwd(), "/path/to/package"),
  quiet: false, // default false
  clear: true, // default false
  noEffects: false, // default false
});

When unbuild --stub and when ts-stub

The first time I saw the concept was in Anthony Fu's post and ts-stub was largely inspired by it.
If you don't know unbuild yet: it is a rollup-based package bundler made by the folks of unjs.
They also do build stubbing with the --stub flag.

Reasons to prefer unbuild --stub

1. Convenience

If you already use unbuild to bundle your packages, there is absolutely no reason for you to use ts-stub.
Just go with unbuild --stub!

2. ESM

ts-stub is designed to typescript only.
If you just bundle esm code and still need stubbing (may be there better alternatives tho) just go with unbuild --stub

Reasons to prefer ts-build

1. Lighter

unbuild is a complete bundler, it's heavier because their scope is larger.
ts-stub is an lighter alternative if you already have a bundler setup and just want stubbing.

2. May be faster

unbuild --stub is powered by jiti (that uses babel) for runtime and rullup with plugins for the esm exports bundle.
ts-stub is powered by tsx (that uses esbuild) for runtime and static analysis for the esm exports bundle