unpkg-bundler

A client-side transpiler, bundler as well as dynamic npm package fetch and load from unpkg.

Install

> npm install unpkg-bundler

Tl;dr

Features

unpkg-bundler is a transpiler and bundler that is made for use in the browser.
Under the hood, it uses esbuild to do the heavy lifting and actually consists of a few esbuild plugins.
supports both ES modules (esm) and CommonJS (cjs). The default entry point is the esm module.
- if you want to use the cjs module require bundle from ./lib/cjs
support for typescript and tsx with react code.

Why bother using unpkg-bundler ?

There are other bundlers out there that run in the browser so why use unpkg-bundler?

The magic of unpkg-bundler is that it will automatically fetch and load npm packages from unpkg and add them to your bundle. 🤯

Usage

unpkg-bundle has a single function: bundle
bundle is an async function
it takes a single required string as an argument and the typescript flag is optional
it returns an object with a code property and an err property.

const bundle = async (input: string, typescript: boolean): { code: string; err: string; } => {...};

Examples

The bundle function is called with a single string as an argument (and optionally the typescript boolean), without access to a file system. This makes it ideal for use in environments without a file system (such as a browser).

Calling bundle

// import the bundle function
import bundle from 'unpkg-bundler';

// call the (async) bundle function.
const output = await bundle('const a = 1;');

// import the bundle function
import bundle from 'unpkg-bundler';

// call the (async) bundle function.
const output = await bundle('const a = 1;', typescript);

Basic Example

// import the bundle function
import bundle from 'unpkg-bundler';

// 'modules' (code strings) to bundle
const mod1 = 'const a = 1;';
const mod2 = 'console.log(a)';

// join the 'modules'
const modules = [mod1, mod2].join('\n');

// remember to mark the function async
const createBundle = async () => {
  // bundle returns an object with two properties: code and err
  const { code, err } = await bundle(modules);
};

Realistic Usage

// react component to bundle
const input = 
`
import React from 'react';
import ReactDOM from 'react-dom';

const App = () => {
  return (
    <div style={{ fontFamily: 'sans-serif', textAlign: 'center' }}>
      <h1>Hello jsx book!</h1>
      <h2>Start editing to create something magic!</h2>
      <p>By the way, you can import (almost) ANY npm package using our magic bundler</p>
    </div>
  );
};

ReactDOM.render(<App />, document.querySelector('#root'));
`;

// unpkg-bundler will automatically:
// 1) fetch react and react-dom from unpkg and load them into your bundle
// 2) transpile your code
// 3) bundle your code
const { code, err } = await bundle(input);

With TypeScript

// react component to bundle
const input = 
`
import React from 'react';
import ReactDOM from 'react-dom';

const App = (): JSX.Element => {
  return (
    <div style={{ fontFamily: 'sans-serif', textAlign: 'center' }}>
      <h1>Hello jsx book!</h1>
      <h2>Start editing to create something magic!</h2>
      <p>By the way, you can import (almost) ANY npm package using our magic bundler</p>
    </div>
  );
};

ReactDOM.render(<App />, document.querySelector('#root'));
`;

// unpkg-bundler will automatically:
// 1) fetch react and react-dom from unpkg and load them into your bundle
// 2) transpile your code
// 3) bundle your code
const { code, err } = await bundle(input, typescript);

Advanced Usage

One way to use unpkg-bundler is as the engine for an online code editor.

Demo App

As a proof of concept, I made a bare bones 'code editor' in just under 90 lines of code using unpkg-bundler.

Motivation

Not too long ago I built an online code editor Contrived I had to write my own bundler and transpiler from scratch.

I spoke to Stephen Grider a fair bit during this time about code execution in the browser.

Stephen recently made a course on Udemy titled: React and Typescript: Build a Portfolio Project.

unpkg-bundler was built as part of that course and I decided to give it a life of it's own.

Fun Fact: unpkg-bundler is also currently powering the app I made in that course here: jsxbook.

Contributing

Yes. Do it. All about that.

How to contribute

Fork the project
Create a feature branch (git checkout -b f/amazingFeature)
Commit your changes (git commit -m 'added awesome sauce')
Push to the remote branch (git push origin f/amazingFeature)
Open a pull request.

Contributors: 1

🐵 Christopher Harold Butler (ChristopherHButler)

License

Distributed under the MIT License. See LICENSE for more information.

ChristopherHButler/unpkg-bundler