https://github.com/georapbox/webpack-library-starter-kit
Webpack starter kit for creating libraries
https://github.com/georapbox/webpack-library-starter-kit
commonjs commonjs-bundle es6 library starter-kit umd umd-bundle umd-modules webpack4
Last synced: about 1 year ago
JSON representation
Webpack starter kit for creating libraries
- Host: GitHub
- URL: https://github.com/georapbox/webpack-library-starter-kit
- Owner: georapbox
- License: mit
- Created: 2018-05-01T16:48:37.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T23:22:58.000Z (over 3 years ago)
- Last Synced: 2025-03-29T00:33:34.614Z (about 1 year ago)
- Topics: commonjs, commonjs-bundle, es6, library, starter-kit, umd, umd-bundle, umd-modules, webpack4
- Language: JavaScript
- Homepage:
- Size: 1.28 MB
- Stars: 16
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/georapbox/webpack-library-starter-kit)
# webpack-library-starter-kit
Webpack starter kit for creating libraries (Input: ES6, Output: UMD, CommonJS)
## Features
- Webpack 4
- Babel 7
- ES6 as a source
- Exports in UMD and CommonJS
- ES6 test setup with [Mocha](https://mochajs.org/) and [Chai](http://www.chaijs.com/)
- Test coverage with [nyc command-line-client for Istanbul](https://github.com/istanbuljs/nyc)
- Linting with [ESLint](https://eslint.org/)
- Basic [Travis](https://travis-ci.org/) configuration
## Getting started
### 1. Setup the library's name
- Open `webpack.config.js` and change the value of `libraryName` variable with your library's name.
- Open `package.json` and change the following properties with your library's equivalent
- `name`
- `version`
- `description`
- `main`
- `repository`
- `author`
- `license`
- `bugs`
- `homepage`
### 2. Install dependencies
- Run `npm install` to install the library's dependencies.
### 3. Build for development
- Having all the dependencies installed run `npm run dev`. This command will generate a `UMD` unminified bundle under the `dist` folder and a `CommonJS` bundle under the `lib` folder. It will also watch for changes in source files to recompile.
### 4. Build for production
- Having all the dependencies installed run `npm run build`. This command will generate two `UMD` bundles (unminified and minified) under the `dist` folder and a `CommonJS` bundle under the `lib` folder.
## Scripts
- `npm run build` - Produces production version of library under `dist` folder for UMD bundle and `lib` folder for `CommonJS` bundle.
- `npm run build:umd` - Produces an **unminified** UMD bundle under the `dist` folder.
- `npm run build:umdmin` - Produces an **minified** UMD bundle under the `dist` folder.
- `npm run build:commonjs` - Produces a CommonJS bundle under the `lib` folder.
- `npm run dev` - Produces a development version of library (both UMD and CommonJS) and runs a watcher to watch for changes.
- `npm run dev:umd` - Produces an unminified UMD bundle under the `dist` folder and runs a watcher to watch for changes.
- `npm run dev:commonjs` - Produces a CommonJS bundle under the `lib` folder and runs a watcher to watch for changes.
- `npm run test` - Runs the tests.
- `npm run coverage` - Runs the tests and provides with test coverage information.
- `npm run lint` - Lints the source code with ESlint.
- `npm run clean` - Deletes `dist`, `lib` and `coverage` folders.
- `npm run prepare` - Run both BEFORE the package is packed and published, on local npm install without any arguments, and when installing git dependencies.
## Misc
- By default all source code is located under the `src` folder.
- Be default `dist` and `lib` folders are excluded from source control but included for npm. You can change this behavior by not excluding these folders inside the `.gitignore` file.
- The starter kit assumes that all tests are located under `test` folder with `.spec.js` extension.
## License
[The MIT License (MIT)](https://georapbox.mit-license.org/@2018)