benitogf / nurbs

how to create a browser library using Rollup

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rollup-starter-browser-lib

Build Status

This repo contains an example of how to create a browser library using Rollup, including testing with karma, mocha and chai.

We're creating a library called Nurbs, which is just a constructor

Getting started

Clone this repository and install its dependencies:

git clone https://github.com/benitogf/nurbs
cd nurbs
npm install

npm run build builds the library to dist, generating three files:

  • dist/nurbs.cjs.js A CommonJS bundle, suitable for use in Node.js, that requires the external dependency. This corresponds to the "main" field in package.json
  • dist/nurbs.esm.js an ES module bundle, suitable for use in other people's libraries and applications, that imports the external dependency. This corresponds to the "module" field in package.json
  • dist/nurbs.umd.js a UMD build, suitable for use in any environment (including the browser, as a <script> tag), that includes the external dependency. This corresponds to the "browser" field in package.json

npm run dev builds the library, then keeps rebuilding it whenever the source files change using rollup-watch.

npm test builds the library, then tests it on firefox, additional karma launchers could be added.

Variations

  • lunch-time - how to create a library using Rollup, including importing a module from node_modules and converting it from CommonJS.
  • babel — illustrates writing the source code in ES2015 and transpiling it for older environments with Babel
  • buble — similar, but using Bublé which is a faster alternative with less configuration

License

MIT.

About

how to create a browser library using Rollup

License:MIT License


Languages

Language:JavaScript 100.0%