zuma

Webpack library starter

Webpack based boilerplate for producing libraries (Input: ES6, Output: universal library)

Features

• Webpack based.
• ES6 as a source.
• Exports in a umd format so your library works everywhere.
• ES6 test setup with Mocha and Chai.
• Linting with ESLint.

Process

ES6 source files
       |
       |
    webpack
       |
       +--- babel, eslint
       |
  ready to use
     library
  in umd format

Getting started

1. Setting up the name of your library

• Open webpack.config.js file and change the value of libraryName variable.
• Open package.json file and change the value of main property so it matches the name of your library.

1. Build your library

• Run npm install to get the project's dependencies
• Run npm run build to produce minified version of your library.

1. Development mode

• Having all the dependencies installed run npm run dev. This command will generate an non-minified version of your library and will run a watcher so you get the compilation on file change.

1. Running the tests

• Run npm run test

Scripts

• npm run build - produces production version of your library under the lib folder
• npm run dev - produces development version of your library and runs a watcher
• npm run test - well ... it runs the tests :)

Readings

• Start your own JavaScript library using webpack and ES6