Skip to main content

Bundler

A lightweight bundler that transpiles and bundles for the web.

Why Use Bundler

  • transpiles and bundles files
  • no configuration required
  • handles imports with and without extensions as well as url imports
  • handles dynamic imports
  • smart splits dependencies
  • --optimize option minifies javascript and css files
  • --watch option observes all dependencies and re-bundles on files changes
  • handles json imports
  • handles css imports and css @import statements
  • supports css postcss-preset-env stage 2 and nesting-rules by default

But there is deno bundle…

Deno offers deno bundle to transpile a file to a standalone module. This might work in some occations but is limited. Bundler works in a similar way to deno bundle but is created with the web in mind. It splits dynamic imports to separate files and injects paths. It splits code that is imported in multiple files so it only is loaded once. The --optimize option also allows for code minification with both javascript and css files. It also has a --watch option that observes all dependencies and re-bundles on files changes.

File extensions and url imports

Typescript as of today does throw an error if an import has a .ts extension or a url.

import { foo } from "bar.ts" // Typescript Error
import * as path from "https://deno.land/std/path/mod.ts"  // Typescript Error

Deno on the other hand does not allow the suspension of extensions.

import { foo } from "bar" // Deno Error

Bundler handles file extensions as well as url imports and uses the same cached files as deno does.

CLI

Installation

Bundler is available as a CLI.

deno install --unstable --allow-read --allow-write --allow-net --allow-env --name bundler https://deno.land/x/bundler/cli.ts

Info: You might need to specify --root /usr/local.

Usage

bundler bundle index.ts=index.js

Options

Option Description Default
-c, –config Load tsconfig.json configuration file {}
–out-dir Name of out_dir “dist”
-h, –help Prints help information
–importmap UNSTABLE: Load import map file {}
–optimize Minify source code false
-q, –quiet Suppress diagnostic output false
-r, –reload Reload source code false
–watch Watch files and re-bundle on change false

Bundler API

Bundler uses the Bundler API to transpile typescript files to javascript.

Usage

import { bundle } from "deno.land/x/bundler/mod.ts"

const inputMap = {
  "src/index.ts": `console.log("Hello World")`
}

const fileMap = {
  "src/index.ts": "dist/index.js"
}

const { outputMap, cacheMap, graph } = await bundle(inputMap, { fileMap })
for (const [output, source] of Object.entries(outputMap)) {
  await fs.ensureFile(output);
  await Deno.writeTextFile(output, source);
}

Smart splitting

What is smart splitting?

Bundler automatically analyzes the dependency graph and splits dependencies from a bundle into a separate files, if the code is used in different entry points. This

  • allows bundle files to share code
  • allows bundle files to import other bundle files
  • makes multiple bundle files smaller, because they will not contain the same code multiple times

Loaders

Typescript

Bundler uses typescript loader by default. You can import typescript and javascript files directly in your files. typescript loader handles modules relative and absolute paths wih and without suffixes as well as urls.

JSON

Bundler uses JSON loader by default. You can import JSON files directly in your files. The JSON loader will convert the file into a javascript module with a default string export.

/* src/data.json */
{
  "foo": "bar"
}
/* src/index.ts */
import data from "./data.json"
console.log(data) // { foo: "bar" }

Info JSON modules is currently at stage 2. The functionality of this loader might change once stage 4 is reached.

CSS

CSS is native to browsers and bundler therefore focuses on making css usage really easy. It supports postcss-preset-env with stage 2 features and nesting-rules enabled so you can use the latest css features out of the box. Bundler uses CSS loader by default. You can import css files directly in your typescript files. The CSS loader will convert the file into a javascript module with a default string export.

/* src/styles.css */
article {
  & > p {
    color: red;
  }
}
/* src/index.ts */
import styles from "./styles.css"
console.log(styles) // article > p { color: red; }

Examples

Hello world

Dependencies

Third party imports

Bundler API

Unstable

This module requires deno to run with the --unstable flag and is likely to change in the future. Do not use in production!