Skip to content
📦 Zero-configuration bundler for tiny modules.
Branch: master
Clone or download
isthatcentered and ForsakenHarmony Readme/newcomer infos (#354)
* Added informations about typescript usage

I admit there's not much there, but as a newcomer I spent some time looking around for it. 
Turns out it's so simple it works by default :D But you have to know it.

* Surfacing the input/output file default config

As a newcomer, I missed this information as it was a bit buried in a big paragraph. I think this might make it stand out a bit more.

* Infos about default input/output

I think it has Its place in the installation phase as it's required for everything to work and has to be set up anyway.

* Cli options at the end of usage chapter

It seems more natural to me to end this way, but really that's subjective.

* Tidy up

* Added typescript to features

It's a very nice feature, it deserves Its place there (I think)

* Added "types" to specifying builds chapter

* Apply suggestions from code review

Co-Authored-By: isthatcentered <e.peninb@gmail.com>

* Apply suggestions from code review

Co-Authored-By: isthatcentered <e.peninb@gmail.com>

* Added latest full cli --help output
Latest commit 41607cf Mar 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Set configFile: false for the Babel plugin handling node_modules Mar 19, 2019
test
.editorconfig
.eslintignore
.eslintrc
.gitignore Merge pull request #245 from luisrudge/master Dec 4, 2018
.npmrc
.travis.yml
CODE_OF_CONDUCT.md
README.md
appveyor.yml Add AppVeyor Dec 14, 2017
babel.config.js
bors.toml Create bors.toml Dec 10, 2018
lint-staged.config.js Turn off eslint rules inconsistent with prettier settings and run pre… May 28, 2018
package.json Merge branch 'master' into replace-expressions-plugin Mar 19, 2019
tsconfig.json

README.md

microbundle

Microbundle npm travis

The zero-configuration bundler for tiny modules, powered by Rollup.


Features:

  • One dependency to bundle your library using only a package.json
  • Support for ESnext & async/await (via Bublé & async-to-promises)
  • Produces tiny, optimized code for all inputs
  • Supports multiple entry modules (cli.js + index.js, etc)
  • Creates multiple output formats for each entry (CJS, UMD & ESM)
  • 0 configuration TypeScript support
  • Built-in Terser compression & gzipped bundle size tracking

🔧 Installation

Download

npm i -D microbundle

Set up your package.json

{
  "source": "src/foo.js",         // Your source file (same as 1st arg to microbundle)
  "main": "dist/foo.js",        // output path for CommonJS/Node
  "module": "dist/foo.mjs",     // output path for JS Modules
  "unpkg": "dist/foo.umd.js",   // optional, for unpkg.com
  "scripts": {
    "build": "microbundle",       // uses "source" and "main" as input and output paths by default
    "dev": "microbundle watch"
  }
}

📦 Usage

Microbundle includes two commands - build (the default) and watch. Neither require any options, but you can tailor things to suit your needs a bit if you like.

microbundle / microbundle build

Unless overridden via the command line, microbundle uses the source property in your package.json to locate the input file, and the main property for the output.

For UMD builds, microbundle will use a snake case version of the name field in your package.json as export name. This can be overridden either by providing an amdName key in your package.json or via the --name flag in the cli.

microbundle watch

Acts just like microbundle build, but watches your source files and rebuilds on any change.

Using with TypeScript

Just point the input to a .ts file through either the cli or the source key in your package.json and you’re done.

Specifying builds in package.json

You can specify output builds in a package.json as follows:

"main": "dist/foo.js",          // CJS bundle
"umd:main": "dist/foo.umd.js",  // UMD bundle
"module": "dist/foo.mjs",       // ES Modules bundle
"source": "src/foo.js",         // custom entry module (same as 1st arg to microbundle)
"types": "dist/foo.d.ts",       // TypeScript typings

Mangling Properties

Libraries often wish to rename internal object properties or class members to smaller names - transforming this._internalIdValue to this._i. Microbundle doesn't currently do this by default, but it can be enabled by adding a "mangle" property to your package.json, with a pattern to control when properties should be mangled. To mangle all property names beginning an underscore, add the following:

{
  "mangle": {
    "regex": "^_"
  }
}

All CLI Options

 Usage
    $ microbundle <command> [options]

  Available Commands
    build    Build once and exit
    watch    Rebuilds on any change

  For more info, run any command with the `--help` flag
    $ microbundle build --help
    $ microbundle watch --help

  Options
    -v, --version    Displays current version
    -i, --entry      Entry module(s)
    -o, --output     Directory to place build files into
    -f, --format     Only build specified formats  (default es,cjs,umd)
    -w, --watch      Rebuilds on any change  (default false)
    --target         Specify your target environment (node or web, default web)
    --external       Specify external dependencies, or 'none'
    --globals        Specify globals dependencies, or 'none'
    --define         Replace constants with hard-coded values
    --alias          Map imports to different modules
    --compress       Compress output using Terser  (default true)
    --strict         Enforce undefined global context and add "use strict"
    --name           Specify name exposed in UMD builds
    --cwd            Use an alternative working directory  (default .)
    --sourcemap      Generate source map  (default true)
    --raw            Show raw byte size  (default false)
    --jsx            A custom JSX pragma like React.createElement (default: h)
    -h, --help       Displays this message

  Examples
    $ microbundle microbundle --globals react=React,jquery=$
    $ microbundle microbundle --define API_KEY=1234
    $ microbundle microbundle --alias react=preact
    $ microbundle microbundle --no-sourcemap # don't generate sourcemaps

🛣 Roadmap

Here's what's coming up for Microbundle:

🔨 Built with Microbundle

🥂 License

MIT

You can’t perform that action at this time.