Speed up your TypeScript monorepo with esbuild
By Mazzarolo Matteo
TypeScript monorepos are a great way to organize medium-to-big size projects. TypeScript improves the developer experience by adding type-checking and a deep IDE integration. And using a monorepo helps in scaling your project(s).
🍊 Tangerine monorepo
While learning esbuild, I haven’t found many examples of how to integrate it within TypeScript monorepos. So I created my own template: 🍊 tangerine-monorepo, a “minimal” TypeScript-based Node.js monorepo setup fully powered by esbuild.
Feb 3rd 2022 update: Tangerine monorepo now uses Turborepo for an even snappier developer experience 🔥
- Uses TypeScript to write code, tests, and scripts.
- Uses esbuild to compile your TypeScript codebase, tests, and scripts.
- Uses Turborepo as a build system to run scripts from the package root.
- Uses tsc CLI to type-check the codebase without emitting the compiled files (since they’re handled by esbuild). No need to keep TypeScript’s Project References up-to-date.
- Uses esbuild-runner to run scripts on the fly.
- Uses Yarn workspaces to make it easy to work within the monorepo.
- Uses a shareable ESLint config and Jest config to provide an extensible linting and testing setup.
- Uses esbuild + nodemon to reload the server in development mode (even when workspace dependencies are changed).
Tangerine monorepo includes five workspaces:
packages/is-even: The simplest workspace — it doesn’t depend on any other worskpace. It’s a Node.js module that exposes an
isEvenfunction that tells if the input number is even. It includes a CLI script that invokes the function from your terminal, and a test file, both written in TypeScript. The CLI script runs using esbuild-runner, which uses esbuild to compile it on the fly.
package/is-odd: Depends on
packages/is-even. It’s a Node.js module that exposes an
isOddfunction that tells if the input number is odd (by invoking
isEvenand checking if it’s false). It includes a CLI script and a test file.
package/server: Depends on both
packages/is-even. It’s a Node.js Express server that exposes two routes that invoke
isOdd. It uses nodemon to reload the server in development mode.
packages/jest-config: Shared Jest config that uses esbuild to compile your tests and your codebase.
packages/eslint-config: Shared ESLint config.
All the workspaces use esbuild to compile the TypeScript codebase. Be it for building, testing, or running CLI scripts, the compilation is instantaneous compared to the native TypeScript compiler (you can quickly test the difference by temporarily swapping esbuild with tsc).
The tsc CLI is used only to type-check the codebase (without emitting the compiled files — since they’re handled by esbuild). I expect people usually use the IDE integration to type-check the code anyway and explicitly invoke the tsc CLI only in specific use cases (such as pre-commit hooks).
Each workspace’s package.json is pointing the
types entry to
src/index.ts. Which might look strange at first, given that it’s uncompiled code… see “You might not need TypeScript project references” on the Turborepo blog for an explanation. This pattern has been working fine for my use cases so far (especially while using esbuild). Still, you might want to update these entries to suit your needs (e.g., when shipping packages to npm).
. └── <project-root>/ └── packages/ ├── eslint-config/ # eslint-config shared across the workspaces ├── is-even/ # simple Node.js module example (with no dependencies) ├── is-odd/ # simple Node.js module example (depends on is-even) ├── jest-config/ # jest-config shared across the workspaces └── server/ # simple Node.js server example (depends on is-even and is-odd)
Why are you using Yarn Classic instead of Yarn 2+?
Mainly because every time I use Yarn 2+ I encounter tiny issues requiring additional fixes or setup (e.g., Editor SDKs).
If you prefer Yarn 2+, switching to it is as easy as running
yarn set version berry 👍.
Why esbuild? Why not swc?
I love swc, but I feel esbuild is still more “mature”. I’ve also noticed that in some cases swc doesn’t respect TypeScript’s
Turborepo is specifically built to support monorepos such as this one.
To me, the major benefits of Turborepo are an fast developer experience (mostly because of caching) and its configurability.
Why are you pointing the package.json’s
types entry to uncompiled code?
See “You might not need TypeScript project references” on the Turborepo blog. This pattern has been working fine for my use cases so far (especially while using esbuild). Still, you might want to update these entries to suit your needs.