2015-01-12 06:17:24 +08:00
This example shows how to create a async loaded commons chunk.
When a chunk has many child chunks which share common modules the `CommonsChunkPlugin` can extract these common modules into a commons chunk which is loaded in parallel to the requested child chunk.
The example entry references two chunks:
* entry chunk
* async require -> chunk X
* async require -> chunk Y
* chunk X
* module `a`
* module `b`
* module `c`
* chunk Y
* module `a`
* module `b`
* module `d`
These chunks share modules `a` and `b` . The `CommonsChunkPlugin` extract these into chunk Z:
* entry chunk
* async require -> chunk X & Z
* async require -> chunk Y & Z
* chunk X
* module `c`
* chunk Y
* module `d`
* chunk Z
* module `a`
* module `b`
Pretty useful for a router in a SPA.
2015-01-12 06:15:11 +08:00
# example.js
``` javascript
// a chunks with a, b, c
require(["./a", "./b", "./c"], function(a, b, c) {});
// a chunk with a, b, d
require.ensure(["./a"], function(require) {
require("./b");
require("./d");
});
```
# webpack.config.js
``` javascript
var CommonsChunkPlugin = require("../../lib/optimize/CommonsChunkPlugin");
2017-03-31 02:25:01 +08:00
2015-01-12 06:15:11 +08:00
module.exports = {
2017-11-24 15:40:39 +08:00
mode: "production",
2015-01-12 06:15:11 +08:00
plugins: [
new CommonsChunkPlugin({
// process all children of the main chunk
// if omitted it would process all chunks
name: "main",
// create a additional async chunk for the common modules
// which is loaded in parallel to the requested chunks
async: true
})
]
2017-03-31 02:25:01 +08:00
};
2015-01-12 06:15:11 +08:00
```
# js/output.js
2017-03-31 02:42:42 +08:00
< details > < summary > < code > /******/ (function(modules) { /* webpackBootstrap */ })< / code > < / summary >
2015-01-12 06:15:11 +08:00
``` javascript
/******/ (function(modules) { // webpackBootstrap
/******/ // install a JSONP callback for chunk loading
2017-11-23 16:47:19 +08:00
/******/ function webpackJsonpCallback(data) {
/******/ var chunkIds = data[0], moreModules = data[1], executeModules = data[2];
2015-01-12 06:15:11 +08:00
/******/ // add "moreModules" to the modules object,
/******/ // then flag all "chunkIds" as loaded and fire callback
2016-06-06 02:51:44 +08:00
/******/ var moduleId, chunkId, i = 0, resolves = [], result;
2015-01-12 06:15:11 +08:00
/******/ for(;i < chunkIds.length ; i + + ) {
/******/ chunkId = chunkIds[i];
2017-05-23 04:45:18 +08:00
/******/ if(installedChunks[chunkId]) {
2016-02-04 07:27:47 +08:00
/******/ resolves.push(installedChunks[chunkId][0]);
2017-05-23 04:45:18 +08:00
/******/ }
2015-01-12 06:15:11 +08:00
/******/ installedChunks[chunkId] = 0;
/******/ }
/******/ for(moduleId in moreModules) {
2016-06-06 02:51:44 +08:00
/******/ if(Object.prototype.hasOwnProperty.call(moreModules, moduleId)) {
/******/ modules[moduleId] = moreModules[moduleId];
/******/ }
2015-01-12 06:15:11 +08:00
/******/ }
2017-11-23 16:47:19 +08:00
/******/ if(parentJsonpFunction) parentJsonpFunction(data);
2017-05-23 04:45:18 +08:00
/******/ while(resolves.length) {
2016-02-04 07:27:47 +08:00
/******/ resolves.shift()();
2017-05-23 04:45:18 +08:00
/******/ }
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // The module cache
/******/ var installedModules = {};
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ // object to store loaded and loading chunks
2015-01-12 06:15:11 +08:00
/******/ var installedChunks = {
2016-09-07 18:28:56 +08:00
/******/ 3: 0
2015-01-12 06:15:11 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ var scheduledModules = [];
/******/
2015-01-12 06:15:11 +08:00
/******/ // The require function
/******/ function __webpack_require__ (moduleId) {
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // Check if module is in cache
2017-05-23 04:45:18 +08:00
/******/ if(installedModules[moduleId]) {
2015-01-12 06:15:11 +08:00
/******/ return installedModules[moduleId].exports;
2017-05-23 04:45:18 +08:00
/******/ }
2015-01-12 06:15:11 +08:00
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
2016-06-06 02:51:44 +08:00
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
2015-01-12 06:15:11 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__ );
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // Flag the module as loaded
2016-06-06 02:51:44 +08:00
/******/ module.l = true;
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // This file contains only the entry chunk.
/******/ // The chunk loading function for additional chunks
2016-02-04 07:27:47 +08:00
/******/ __webpack_require__ .e = function requireEnsure(chunkId) {
2017-11-23 16:47:19 +08:00
/******/ var promises = [];
2017-03-31 02:25:01 +08:00
/******/
/******/
2017-11-23 16:47:19 +08:00
/******/ // JSONP chunk loading for javascript
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ var installedChunkData = installedChunks[chunkId];
/******/ if(installedChunkData !== 0) { // 0 means "already installed".
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ // a Promise means "currently loading".
/******/ if(installedChunkData) {
/******/ promises.push(installedChunkData[2]);
/******/ } else {
/******/ // setup Promise in chunk cache
/******/ var promise = new Promise(function(resolve, reject) {
/******/ installedChunkData = installedChunks[chunkId] = [resolve, reject];
/******/ });
/******/ promises.push(installedChunkData[2] = promise);
/******/
/******/ // start chunk loading
/******/ var head = document.getElementsByTagName('head')[0];
/******/ var script = document.createElement('script');
/******/ script.charset = 'utf-8';
/******/ script.timeout = 120000;
/******/
/******/ if (__webpack_require__.nc) {
/******/ script.setAttribute("nonce", __webpack_require__ .nc);
2017-05-23 04:45:18 +08:00
/******/ }
2017-11-23 16:47:19 +08:00
/******/ script.src = __webpack_require__ .p + "" + chunkId + ".output.js";
/******/ var timeout = setTimeout(function(){
/******/ onScriptComplete({ type: 'timeout', target: script });
/******/ }, 120000);
/******/ script.onerror = script.onload = onScriptComplete;
/******/ function onScriptComplete(event) {
/******/ // avoid mem leaks in IE.
/******/ script.onerror = script.onload = null;
/******/ clearTimeout(timeout);
/******/ var chunk = installedChunks[chunkId];
/******/ if(chunk !== 0) {
/******/ if(chunk) {
/******/ var errorType = event & & (event.type === 'load' ? 'missing' : event.type);
/******/ var realSrc = event & & event.target & & event.target.src;
/******/ var error = new Error('Loading chunk ' + chunkId + ' failed.\n(' + errorType + ': ' + realSrc + ')');
/******/ error.type = errorType;
/******/ error.request = realSrc;
/******/ chunk[1](error);
/******/ }
/******/ installedChunks[chunkId] = undefined;
/******/ }
/******/ };
/******/ head.appendChild(script);
2016-02-04 07:27:47 +08:00
/******/ }
2017-11-23 16:47:19 +08:00
/******/ }
/******/ return Promise.all(promises);
2015-01-12 06:15:11 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__ .m = modules;
2017-03-31 02:25:01 +08:00
/******/
2015-01-12 06:15:11 +08:00
/******/ // expose the module cache
/******/ __webpack_require__ .c = installedModules;
2017-03-31 02:25:01 +08:00
/******/
2016-12-08 02:14:47 +08:00
/******/ // define getter function for harmony exports
2016-09-07 18:28:56 +08:00
/******/ __webpack_require__ .d = function(exports, name, getter) {
2016-12-14 19:03:24 +08:00
/******/ if(!__webpack_require__.o(exports, name)) {
/******/ Object.defineProperty(exports, name, {
/******/ configurable: false,
/******/ enumerable: true,
/******/ get: getter
/******/ });
/******/ }
2016-09-07 18:28:56 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2017-11-24 15:40:39 +08:00
/******/ // define __esModule on exports
/******/ __webpack_require__ .r = function(exports) {
/******/ Object.defineProperty(exports, '__esModule', { value: true });
/******/ };
/******/
2016-09-07 18:28:56 +08:00
/******/ // getDefaultExport function for compatibility with non-harmony modules
/******/ __webpack_require__ .n = function(module) {
/******/ var getter = module & & module.__esModule ?
/******/ function getDefault() { return module['default']; } :
/******/ function getModuleExports() { return module; };
/******/ __webpack_require__ .d(getter, 'a', getter);
/******/ return getter;
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2016-09-07 18:28:56 +08:00
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__ .o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
2017-03-31 02:25:01 +08:00
/******/
2016-02-04 20:02:53 +08:00
/******/ // __webpack_public_path__
/******/ __webpack_require__ .p = "js/";
2017-03-31 02:25:01 +08:00
/******/
2016-02-04 07:27:47 +08:00
/******/ // on error function for async loading
2016-06-06 02:51:44 +08:00
/******/ __webpack_require__ .oe = function(err) { console.error(err); throw err; };
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ var jsonpArray = window["webpackJsonp"] = window["webpackJsonp"] || [];
/******/ var parentJsonpFunction = jsonpArray.push.bind(jsonpArray);
/******/ jsonpArray.push = webpackJsonpCallback;
/******/ jsonpArray = jsonpArray.slice();
/******/ for(var i = 0; i < jsonpArray.length ; i + + ) webpackJsonpCallback ( jsonpArray [ i ] ) ;
/******/
2015-01-12 06:15:11 +08:00
/******/ // Load entry module and return exports
2017-06-05 22:12:12 +08:00
/******/ return __webpack_require__ (__webpack_require__.s = 2);
2015-01-12 06:15:11 +08:00
/******/ })
/************************************************************************/
2016-09-07 18:28:56 +08:00
```
2017-03-31 02:42:42 +08:00
2016-09-07 18:28:56 +08:00
< / details >
2017-03-31 02:42:42 +08:00
2016-09-07 18:28:56 +08:00
``` javascript
2016-02-04 07:27:47 +08:00
/******/ ({
2017-06-05 22:12:12 +08:00
/***/ 2:
2015-01-12 06:15:11 +08:00
/*!********************!*\
!*** ./example.js ** *!
\********************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
/*! all exports used */
2017-11-24 15:40:39 +08:00
/*! ModuleConcatenation bailout: Module is not an ECMAScript module */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports, __webpack_require__ ) {
2015-01-12 06:15:11 +08:00
2016-09-07 18:28:56 +08:00
// a chunks with a, b, c
2017-11-23 16:47:19 +08:00
Promise.all/* require */([__webpack_require__.e(0), __webpack_require__.e(2)]).then(function() { var __WEBPACK_AMD_REQUIRE_ARRAY__ = [__webpack_require__(/* ! ./a */ 0), __webpack_require__(/* ! ./b */ 1), __webpack_require__(/* ! ./c */ 3)]; ((function(a, b, c) {}).apply(null, __WEBPACK_AMD_REQUIRE_ARRAY__ ));}).catch(__webpack_require__.oe);
2015-01-12 06:15:11 +08:00
2016-09-07 18:28:56 +08:00
// a chunk with a, b, d
2016-12-14 19:03:24 +08:00
Promise.all/* require.ensure */([__webpack_require__.e(0), __webpack_require__ .e(1)]).then((function(require) {
2016-09-07 18:28:56 +08:00
__webpack_require__ (/*! ./b */ 1);
2017-06-05 22:12:12 +08:00
__webpack_require__ (/*! ./d */ 4);
2016-12-14 19:03:24 +08:00
}).bind(null, __webpack_require__ )).catch(__webpack_require__.oe);
2015-01-12 06:15:11 +08:00
2017-03-31 02:25:01 +08:00
/***/ })
2016-02-04 07:27:47 +08:00
/******/ });
2015-01-12 06:15:11 +08:00
```
2016-09-30 06:01:24 +08:00
# js/0.output.js
2015-01-12 06:15:11 +08:00
``` javascript
2017-11-23 16:47:19 +08:00
(window["webpackJsonp"] = window["webpackJsonp"] || []).push([[0],[
2016-02-04 07:27:47 +08:00
/* 0 */
/*!**************!*\
!*** ./a.js ** *!
\**************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
/*! all exports used */
2017-11-24 15:40:39 +08:00
/*! ModuleConcatenation bailout: Module is not an ECMAScript module */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports) {
2015-01-12 06:15:11 +08:00
2016-09-07 18:28:56 +08:00
module.exports = "a";
2016-02-04 07:27:47 +08:00
2017-03-31 02:25:01 +08:00
/***/ }),
2016-02-04 07:27:47 +08:00
/* 1 */
2015-01-12 06:15:11 +08:00
/*!**************!*\
2016-02-04 07:27:47 +08:00
!*** ./b.js ** *!
2015-01-12 06:15:11 +08:00
\**************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
/*! all exports used */
2017-11-24 15:40:39 +08:00
/*! ModuleConcatenation bailout: Module is not an ECMAScript module */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports) {
2015-01-12 06:15:11 +08:00
2016-09-07 18:28:56 +08:00
module.exports = "b";
2015-01-12 06:15:11 +08:00
2017-03-31 02:25:01 +08:00
/***/ })
2017-11-23 16:47:19 +08:00
]]);
2015-01-12 06:15:11 +08:00
```
2016-09-30 06:01:24 +08:00
# js/1.output.js
2015-01-12 06:15:11 +08:00
``` javascript
2017-11-23 16:47:19 +08:00
(window["webpackJsonp"] = window["webpackJsonp"] || []).push([[1],{
2015-01-12 06:15:11 +08:00
2017-06-05 22:12:12 +08:00
/***/ 4:
2015-01-12 06:15:11 +08:00
/*!**************!*\
!*** ./d.js ** *!
\**************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
/*! all exports used */
2017-11-24 15:40:39 +08:00
/*! ModuleConcatenation bailout: Module is not an ECMAScript module */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports) {
2015-01-12 06:15:11 +08:00
2016-09-07 18:28:56 +08:00
module.exports = "d";
2015-01-12 06:15:11 +08:00
2017-03-31 02:25:01 +08:00
/***/ })
2015-01-12 06:15:11 +08:00
2017-11-23 16:47:19 +08:00
}]);
2015-01-12 06:15:11 +08:00
```
2016-09-30 06:01:24 +08:00
# js/2.output.js
2015-01-12 06:15:11 +08:00
``` javascript
2017-11-23 16:47:19 +08:00
(window["webpackJsonp"] = window["webpackJsonp"] || []).push([[2],{
2015-01-12 06:15:11 +08:00
2017-06-05 22:12:12 +08:00
/***/ 3:
2015-01-12 06:15:11 +08:00
/*!**************!*\
2016-02-04 07:27:47 +08:00
!*** ./c.js ** *!
2015-01-12 06:15:11 +08:00
\**************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
/*! all exports used */
2017-11-24 15:40:39 +08:00
/*! ModuleConcatenation bailout: Module is not an ECMAScript module */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports) {
2015-01-12 06:15:11 +08:00
2016-09-07 18:28:56 +08:00
module.exports = "c";
2015-01-12 06:15:11 +08:00
2017-03-31 02:25:01 +08:00
/***/ })
2016-02-04 07:27:47 +08:00
2017-11-23 16:47:19 +08:00
}]);
2015-01-12 06:15:11 +08:00
```
# Info
## Uncompressed
```
2017-11-23 16:47:19 +08:00
Hash: 7fbb1fd30d6b2c043e7a
Version: webpack next
2016-09-30 06:01:24 +08:00
Asset Size Chunks Chunk Names
2017-11-24 15:40:39 +08:00
0.output.js 595 bytes 0 [emitted]
1.output.js 336 bytes 1 [emitted]
2.output.js 336 bytes 2 [emitted]
output.js 7.47 KiB 3 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2016-09-30 06:01:24 +08:00
chunk {0} 0.output.js 42 bytes {3} [rendered]
2017-06-05 22:12:12 +08:00
> async commons [2] ./example.js 2:0-52
> async commons [2] ./example.js 5:0-8:2
2016-02-04 07:27:47 +08:00
[0] ./a.js 21 bytes {0} [built]
2017-06-05 22:12:12 +08:00
amd require ./a [2] ./example.js 2:0-52
require.ensure item ./a [2] ./example.js 5:0-8:2
2016-02-04 07:27:47 +08:00
[1] ./b.js 21 bytes {0} [built]
2017-06-05 22:12:12 +08:00
amd require ./b [2] ./example.js 2:0-52
cjs require ./b [2] ./example.js 6:1-15
2016-09-30 06:01:24 +08:00
chunk {1} 1.output.js 21 bytes {3} [rendered]
2017-06-05 22:12:12 +08:00
> [2] ./example.js 5:0-8:2
[4] ./d.js 21 bytes {1} [built]
cjs require ./d [2] ./example.js 7:1-15
2016-09-30 06:01:24 +08:00
chunk {2} 2.output.js 21 bytes {3} [rendered]
2017-06-05 22:12:12 +08:00
> [2] ./example.js 2:0-52
[3] ./c.js 21 bytes {2} [built]
amd require ./c [2] ./example.js 2:0-52
2016-12-14 19:03:24 +08:00
chunk {3} output.js (main) 194 bytes [entry] [rendered]
2017-06-05 22:12:12 +08:00
> main [2] ./example.js
[2] ./example.js 194 bytes {3} [built]
2017-11-23 16:47:19 +08:00
single entry .\example.js main
2015-01-12 06:15:11 +08:00
```
## Minimized (uglify-js, no zip)
```
2017-11-23 16:47:19 +08:00
Hash: 7fbb1fd30d6b2c043e7a
Version: webpack next
Asset Size Chunks Chunk Names
0.output.js 118 bytes 0 [emitted]
1.output.js 91 bytes 1 [emitted]
2.output.js 91 bytes 2 [emitted]
2017-11-24 15:40:39 +08:00
output.js 1.77 KiB 3 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2016-09-30 06:01:24 +08:00
chunk {0} 0.output.js 42 bytes {3} [rendered]
2017-06-05 22:12:12 +08:00
> async commons [2] ./example.js 2:0-52
> async commons [2] ./example.js 5:0-8:2
2016-02-04 07:27:47 +08:00
[0] ./a.js 21 bytes {0} [built]
2017-06-05 22:12:12 +08:00
amd require ./a [2] ./example.js 2:0-52
require.ensure item ./a [2] ./example.js 5:0-8:2
2016-02-04 07:27:47 +08:00
[1] ./b.js 21 bytes {0} [built]
2017-06-05 22:12:12 +08:00
amd require ./b [2] ./example.js 2:0-52
cjs require ./b [2] ./example.js 6:1-15
2016-09-30 06:01:24 +08:00
chunk {1} 1.output.js 21 bytes {3} [rendered]
2017-06-05 22:12:12 +08:00
> [2] ./example.js 5:0-8:2
[4] ./d.js 21 bytes {1} [built]
cjs require ./d [2] ./example.js 7:1-15
2016-09-30 06:01:24 +08:00
chunk {2} 2.output.js 21 bytes {3} [rendered]
2017-06-05 22:12:12 +08:00
> [2] ./example.js 2:0-52
[3] ./c.js 21 bytes {2} [built]
amd require ./c [2] ./example.js 2:0-52
2016-12-14 19:03:24 +08:00
chunk {3} output.js (main) 194 bytes [entry] [rendered]
2017-06-05 22:12:12 +08:00
> main [2] ./example.js
[2] ./example.js 194 bytes {3} [built]
2017-11-23 16:47:19 +08:00
single entry .\example.js main
2015-01-12 06:15:11 +08:00
```