Universal library generator
A simple Yeoman generator to create ES6 universal (UMD) libraries.
Inspired from Generator-babel-boilerplate but with Webpack instead of Gulp to make it fast.
Features
- Webpack as module bundler
- Lint with ESLint
- Compiles from ES6 to ES5 with Babel 6
- Development and production (with UglifyJS plugin) builds
- Easily configurable in a
package.json
field
Installation
First, install Yeoman and this generator as below :
npm i -g yo generator-universal-library
Then generate your new project in a new folder :
mkdir my-library && cd $_
yo universal-library
Usage
When you launch the generator, Yeoman will ask you a bunch of questions, create some code boilerplate and install NPM dependencies.
Then, you can write your library code in src
folder. An empty file is present as a default entry file.
Note : The default entry file name depend on what you entered for the repository name.
It can be easily changed inpackage.json
file inlibrary.entry
field.
Next, choose production or development environment for the build :
Note : Every time you build, the
lib
folder get deleted.
Production
Run npm run build
to compile and minify the code.
Development
Run npm start
or npm run dev
, Webpack watch and rebuild the code every time a modification is made.
Then, compiled code will be available in lib
folder.
NPM Scripts
-
npm start
ornpm run dev
- Build the library in development mode (watch and rebuilding on fly). -
npm build
- Build the library in production mode (with UglifyJS). -
npm lint
- Lint the source code.
FAQ
How can I customize entry/output file name ?
You can configure default values in package.json
file :
"library": {
"name": "my-library",
"entry": "my-library.js"
}
License
MIT © Fabien Motte