Merge pull request #5388 from webpack/example/dll-app-and-vendor

add dll-app-and-vendor example by @aretecode
This commit is contained in:
Tobias Koppers 2017-07-27 15:13:28 +02:00 committed by GitHub
commit d6d6134ca6
15 changed files with 753 additions and 0 deletions

View File

@ -0,0 +1,185 @@
This is the vendor build part.
It's built separatly from the app part. The vendors dll is only built when vendors has changed and not while the normal development cycle.
The DllPlugin in combination with the `output.library` option exposes the internal require function as global variable in the target enviroment.
A manifest is creates which includes mappings from module names to internal ids.
### webpack.config.js
``` javascript
var path = require("path");
var webpack = require("../../../");
module.exports = {
context: __dirname,
entry: ["example-vendor"],
output: {
filename: "vendor.js", // best use [hash] here too
path: path.resolve(__dirname, "js"),
library: "vendor_lib_[hash]",
},
plugins: [
new webpack.DllPlugin({
name: "vendor_lib_[hash]",
path: path.resolve(__dirname, "js/vendor-manifest.json"),
}),
],
};
```
# example-vendor
``` javascript
export function square(n) {
return n * n;
}
```
# js/vendor.js
``` javascript
var vendor_lib_6b1edee0549eb5092709 =
```
<details><summary><code>/******/ (function(modules) { /* webpackBootstrap */ })</code></summary>
``` js
/******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId]) {
/******/ return installedModules[moduleId].exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.l = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // define getter function for harmony exports
/******/ __webpack_require__.d = function(exports, name, getter) {
/******/ if(!__webpack_require__.o(exports, name)) {
/******/ Object.defineProperty(exports, name, {
/******/ configurable: false,
/******/ enumerable: true,
/******/ get: getter
/******/ });
/******/ }
/******/ };
/******/
/******/ // 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;
/******/ };
/******/
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "js/";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = 0);
/******/ })
/************************************************************************/
```
</details>
``` js
/******/ ([
/* 0 */
/*!****************!*\
!*** dll main ***!
\****************/
/*! no static exports found */
/*! all exports used */
/***/ (function(module, exports, __webpack_require__) {
module.exports = __webpack_require__;
/***/ }),
/* 1 */
/*!*****************************************!*\
!*** ../node_modules/example-vendor.js ***!
\*****************************************/
/*! exports provided: square */
/*! all exports used */
/***/ (function(module, __webpack_exports__, __webpack_require__) {
"use strict";
Object.defineProperty(__webpack_exports__, "__esModule", { value: true });
/* harmony export (immutable) */ __webpack_exports__["square"] = square;
function square(n) {
return n * n;
}
/***/ })
/******/ ]);
```
# js/vendor-manifest.json
``` javascript
{"name":"vendor_lib_6b1edee0549eb5092709","content":{"../node_modules/example-vendor.js":{"id":1,"meta":{"harmonyModule":true},"exports":["square"]}}}
```
# Info
## Uncompressed
```
Hash: 6b1edee0549eb5092709
Version: webpack 3.4.1
Asset Size Chunks Chunk Names
vendor.js 3.18 kB 0 [emitted] main
Entrypoint main = vendor.js
chunk {0} vendor.js (main) 60 bytes [entry] [rendered]
> main [0] dll main
[0] dll main 12 bytes {0} [built]
+ 1 hidden module
```
## Minimized (uglify-js, no zip)
```
Hash: 6b1edee0549eb5092709
Version: webpack 3.4.1
Asset Size Chunks Chunk Names
vendor.js 652 bytes 0 [emitted] main
Entrypoint main = vendor.js
chunk {0} vendor.js (main) 60 bytes [entry] [rendered]
> main [0] dll main
[0] dll main 12 bytes {0} [built]
+ 1 hidden module
```

View File

@ -0,0 +1,2 @@
global.NO_TARGET_ARGS = true;
require("../../build-common");

View File

@ -0,0 +1 @@
{"name":"vendor_lib_6b1edee0549eb5092709","content":{"../node_modules/example-vendor.js":{"id":1,"meta":{"harmonyModule":true},"exports":["square"]}}}

View File

@ -0,0 +1,96 @@
var vendor_lib_6b1edee0549eb5092709 =
/******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId]) {
/******/ return installedModules[moduleId].exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.l = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // define getter function for harmony exports
/******/ __webpack_require__.d = function(exports, name, getter) {
/******/ if(!__webpack_require__.o(exports, name)) {
/******/ Object.defineProperty(exports, name, {
/******/ configurable: false,
/******/ enumerable: true,
/******/ get: getter
/******/ });
/******/ }
/******/ };
/******/
/******/ // 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;
/******/ };
/******/
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "js/";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = 0);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */
/*!****************!*\
!*** dll main ***!
\****************/
/*! no static exports found */
/*! all exports used */
/***/ (function(module, exports, __webpack_require__) {
module.exports = __webpack_require__;
/***/ }),
/* 1 */
/*!*****************************************!*\
!*** ../node_modules/example-vendor.js ***!
\*****************************************/
/*! exports provided: square */
/*! all exports used */
/***/ (function(module, __webpack_exports__, __webpack_require__) {
"use strict";
Object.defineProperty(__webpack_exports__, "__esModule", { value: true });
/* harmony export (immutable) */ __webpack_exports__["square"] = square;
function square(n) {
return n * n;
}
/***/ })
/******/ ]);

View File

@ -0,0 +1,46 @@
This is the vendor build part.
It's built separatly from the app part. The vendors dll is only built when vendors has changed and not while the normal development cycle.
The DllPlugin in combination with the `output.library` option exposes the internal require function as global variable in the target enviroment.
A manifest is creates which includes mappings from module names to internal ids.
### webpack.config.js
``` javascript
{{webpack.config.js}}
```
# example-vendor
``` javascript
{{../node_modules/example-vendor.js}}
```
# js/vendor.js
``` javascript
{{js/vendor.js}}
```
# js/vendor-manifest.json
``` javascript
{{js/vendor-manifest.json}}
```
# Info
## Uncompressed
```
{{stdout}}
```
## Minimized (uglify-js, no zip)
```
{{min:stdout}}
```

View File

@ -0,0 +1,18 @@
var path = require("path");
var webpack = require("../../../");
module.exports = {
context: __dirname,
entry: ["example-vendor"],
output: {
filename: "vendor.js", // best use [hash] here too
path: path.resolve(__dirname, "js"),
library: "vendor_lib_[hash]",
},
plugins: [
new webpack.DllPlugin({
name: "vendor_lib_[hash]",
path: path.resolve(__dirname, "js/vendor-manifest.json"),
}),
],
};

View File

@ -0,0 +1,209 @@
This is the app part.
The previously built vendor dll is used. The DllReferencePlugin reads the content of the dll from the manifest file and excludes all vendor modules from the compilation. Instead references to these modules will be loaded from the vendor dll via a global variable (`vendor_lib_xxxx`).
# webpack.config.js
``` javascript
var path = require("path");
var webpack = require("../../../");
module.exports = {
context: __dirname,
entry: "./example-app",
output: {
filename: "app.js",
path: path.resolve(__dirname, "js"),
},
plugins: [
new webpack.DllReferencePlugin({
context: ".",
manifest: require("../0-vendor/js/vendor-manifest.json"), // eslint-disable-line
}),
],
};
```
# example-app.js
``` javascript
import { square } from "example-vendor";
console.log(square(7));
console.log(new square(7));
```
# example.html
``` html
<html>
<head></head>
<body>
<script src="js/vendor.bundle.js" charset="utf-8"></script>
<script src="js/app.bundle.js" charset="utf-8"></script>
</body>
</html>
```
# js/app.js
<details><summary><code>/******/ (function(modules) { /* webpackBootstrap */ })</code></summary>
``` javascript
/******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId]) {
/******/ return installedModules[moduleId].exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.l = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // define getter function for harmony exports
/******/ __webpack_require__.d = function(exports, name, getter) {
/******/ if(!__webpack_require__.o(exports, name)) {
/******/ Object.defineProperty(exports, name, {
/******/ configurable: false,
/******/ enumerable: true,
/******/ get: getter
/******/ });
/******/ }
/******/ };
/******/
/******/ // 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;
/******/ };
/******/
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "js/";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = 0);
/******/ })
/************************************************************************/
```
</details>
``` javascript
/******/ ([
/* 0 */
/*!************************!*\
!*** ./example-app.js ***!
\************************/
/*! exports provided: */
/*! all exports used */
/***/ (function(module, __webpack_exports__, __webpack_require__) {
"use strict";
Object.defineProperty(__webpack_exports__, "__esModule", { value: true });
/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0_example_vendor__ = __webpack_require__(/*! example-vendor */ 1);
console.log(Object(__WEBPACK_IMPORTED_MODULE_0_example_vendor__["square"])(7));
console.log(new __WEBPACK_IMPORTED_MODULE_0_example_vendor__["square"](7));
/***/ }),
/* 1 */
/*!******************************************************************************************************!*\
!*** delegated ../node_modules/example-vendor.js from dll-reference vendor_lib_6b1edee0549eb5092709 ***!
\******************************************************************************************************/
/*! exports provided: square */
/*! all exports used */
/***/ (function(module, exports, __webpack_require__) {
module.exports = (__webpack_require__(2))(1);
/***/ }),
/* 2 */
/*!**************************************************!*\
!*** external "vendor_lib_6b1edee0549eb5092709" ***!
\**************************************************/
/*! no static exports found */
/*! all exports used */
/***/ (function(module, exports) {
module.exports = vendor_lib_6b1edee0549eb5092709;
/***/ })
/******/ ]);
```
# Info
## Uncompressed
```
Hash: 26778169dabaf1f3965d
Version: webpack 3.4.1
Asset Size Chunks Chunk Names
app.js 3.85 kB 0 [emitted] main
Entrypoint main = app.js
chunk {0} app.js (main) 182 bytes [entry] [rendered]
> main [0] ./example-app.js
[0] ./example-app.js 98 bytes {0} [built]
[no exports]
[1] delegated ../node_modules/example-vendor.js from dll-reference vendor_lib_6b1edee0549eb5092709 42 bytes {0} [built]
[exports: square]
harmony import example-vendor [0] ./example-app.js 1:0-40
+ 1 hidden module
```
## Minimized (uglify-js, no zip)
```
Hash: 26778169dabaf1f3965d
Version: webpack 3.4.1
Asset Size Chunks Chunk Names
app.js 710 bytes 0 [emitted] main
Entrypoint main = app.js
chunk {0} app.js (main) 182 bytes [entry] [rendered]
> main [0] ./example-app.js
[0] ./example-app.js 98 bytes {0} [built]
[no exports]
[1] delegated ../node_modules/example-vendor.js from dll-reference vendor_lib_6b1edee0549eb5092709 42 bytes {0} [built]
[exports: square]
harmony import example-vendor [0] ./example-app.js 1:0-40
+ 1 hidden module
```
<!-- @TODO:
- [ ] examples/dll-mode-and-context
- [ ] examples/dll-multiple
- [ ] examples/dll-dependencies
-->

View File

@ -0,0 +1,2 @@
global.NO_TARGET_ARGS = true;
require("../../build-common");

View File

@ -0,0 +1,4 @@
import { square } from "example-vendor";
console.log(square(7));
console.log(new square(7));

View File

@ -0,0 +1,7 @@
<html>
<head></head>
<body>
<script src="js/vendor.bundle.js" charset="utf-8"></script>
<script src="js/app.bundle.js" charset="utf-8"></script>
</body>
</html>

View File

@ -0,0 +1,107 @@
/******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId]) {
/******/ return installedModules[moduleId].exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.l = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // define getter function for harmony exports
/******/ __webpack_require__.d = function(exports, name, getter) {
/******/ if(!__webpack_require__.o(exports, name)) {
/******/ Object.defineProperty(exports, name, {
/******/ configurable: false,
/******/ enumerable: true,
/******/ get: getter
/******/ });
/******/ }
/******/ };
/******/
/******/ // 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;
/******/ };
/******/
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "js/";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = 0);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */
/*!************************!*\
!*** ./example-app.js ***!
\************************/
/*! exports provided: */
/*! all exports used */
/***/ (function(module, __webpack_exports__, __webpack_require__) {
"use strict";
Object.defineProperty(__webpack_exports__, "__esModule", { value: true });
/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0_example_vendor__ = __webpack_require__(/*! example-vendor */ 1);
console.log(Object(__WEBPACK_IMPORTED_MODULE_0_example_vendor__["square"])(7));
console.log(new __WEBPACK_IMPORTED_MODULE_0_example_vendor__["square"](7));
/***/ }),
/* 1 */
/*!******************************************************************************************************!*\
!*** delegated ../node_modules/example-vendor.js from dll-reference vendor_lib_6b1edee0549eb5092709 ***!
\******************************************************************************************************/
/*! exports provided: square */
/*! all exports used */
/***/ (function(module, exports, __webpack_require__) {
module.exports = (__webpack_require__(2))(1);
/***/ }),
/* 2 */
/*!**************************************************!*\
!*** external "vendor_lib_6b1edee0549eb5092709" ***!
\**************************************************/
/*! no static exports found */
/*! all exports used */
/***/ (function(module, exports) {
module.exports = vendor_lib_6b1edee0549eb5092709;
/***/ })
/******/ ]);

View File

@ -0,0 +1,47 @@
This is the app part.
The previously built vendor dll is used. The DllReferencePlugin reads the content of the dll from the manifest file and excludes all vendor modules from the compilation. Instead references to these modules will be loaded from the vendor dll via a global variable (`vendor_lib_xxxx`).
# webpack.config.js
``` javascript
{{webpack.config.js}}
```
# example-app.js
``` javascript
{{example-app.js}}
```
# example.html
``` html
{{example.html}}
```
# js/app.js
``` javascript
{{js/app.js}}
```
# Info
## Uncompressed
```
{{stdout}}
```
## Minimized (uglify-js, no zip)
```
{{min:stdout}}
```
<!-- @TODO:
- [ ] examples/dll-mode-and-context
- [ ] examples/dll-multiple
- [ ] examples/dll-dependencies
-->

View File

@ -0,0 +1,17 @@
var path = require("path");
var webpack = require("../../../");
module.exports = {
context: __dirname,
entry: "./example-app",
output: {
filename: "app.js",
path: path.resolve(__dirname, "js"),
},
plugins: [
new webpack.DllReferencePlugin({
context: ".",
manifest: require("../0-vendor/js/vendor-manifest.json"), // eslint-disable-line
}),
],
};

View File

@ -0,0 +1,9 @@
This example shows how to use the DllPlugin to separate vendor and app build.
This can boost the speed of the app build because vendors are no longer included, but built separately.
See [vendor part](0-vendor) and [app part](1-app).
[DllPlugin documentation](https://webpack.js.org/plugins/dll-plugin)
> Based on this gist: https://gist.github.com/Eoksni/83d1f1559e0ec00d0e89c33a6d763049 by Eoksni

View File

@ -0,0 +1,3 @@
export function square(n) {
return n * n;
}