@jsheaven/easybuild

Super-fast and simple IIFE, ESM and CJS bundler for JavaScript and TypeScript. Comes with an easy API and CLI. One file in, one file out. Supports node and browser output. Generates .map and .d.ts files. Minifies and prints the final code size.

User Stories

1. As a developer, I don't want to configure esbuild again and again to gain the same results.
2. As a developer, I want to have esbuild configured to bundle for browser or node and generate CJS, ESM and IIFE likewise
3. As a developer, I don't want esbuild to fail on __dirname and __filename not being defined
4. As a developer, I don't want node_modules to be bundled in when bundlung for Node.js
5. As a developer, I want to have an API and CLI to simply build one file at a time
6. As a developer, I want to see the file sizes raw, gzip and brotli compressed

Features

• ✅ Configures esbuild to simply generate one output (per module type) JavaScript for one input TypeScript/JavaScript
• ✅ Generates cjs, esm and iife invariants automatically
• ✅ Full support for .d.ts bundling and type checking
• ✅ Prints the file sizes per compression type gzip and brotli, when done
• ✅ Just 1849b nano sized (ESM, gizpped)
• ✅ Available as CLI and API
• ✅ Fixes several unintuitive esbuild default behaviours
• ✅ Runs on Windows, Mac, Linux, CI tested
• ✅ First class TypeScript support
• ✅ 100% Unit Test coverage

Example usage (CLI)

For Node.js: npx @jsheaven/easybuild ./src/index.ts ./dist/index.js node

For browsers: npx @jsheaven/easybuild ./src/index.ts ./dist/index.js browser

You need at least version 18 of Node.js installed.

Example usage (API, as a library)

Setup

• yarn: yarn add @jsheaven/easybuild
• npm: npm install @jsheaven/easybuild

ESM

import { buildForNode, buildForBrowser } from '@jsheaven/easybuild'

await buildForNode({
  // source file to build
  entryPoint: './src/cli.ts',
  // file to generate (actually, generates invariants like ./dist/cli.iife.js, etc.)
  outfile: './dist/cli.js',
  // allows to disable all minification and tree shaking with one flag
  debug: false,
  // generated .d.ts files, but drives the build-time and may cause typing errors
  dts: true,
  // specific configuration for the .d.ts bundle output
  dtsOutputOptions: {
    exportReferencedTypes: true,
    inlineDeclareExternals: true,
    inlineDeclareGlobals: true,
    noBanner: true,
    sortNodes: true,
  },
  // allows to inline types (.d.ts) of dependent libraries etc.
  dtsLibOptions: { ... },
  // in case you want to set any extra esbuild options
  esBuildOptions: {
    // usually, Node.js builds are not bundled, but e.g. for CLIs you want that
    bundle: true,
  },
})

CommonJS

const { buildForNode, buildForBrowser } = require('@jsheaven/easybuild')

// same API like ESM variant