webpack/examples/loader/README.md

300 lines
8.3 KiB
Markdown
Raw Normal View History

2012-03-27 06:00:51 +08:00
# example.js
``` javascript
// use our loader
console.dir(require("./loader!./file"));
// use buildin css loader
console.dir(require("./test.css")); // default by extension
console.dir(require("!css-loader!./test.css")); // manual
2012-03-27 06:00:51 +08:00
```
# file.js
``` javascript
exports.foo = "bar";
```
# loader.js
``` javascript
2012-04-05 21:08:49 +08:00
module.exports = function(content) {
return "exports.answer = 42;\n" + content;
2012-03-27 06:00:51 +08:00
}
```
# test.css
2012-03-27 06:00:51 +08:00
2016-12-14 19:03:24 +08:00
``` css
.some-class {
color: hotpink;
2012-03-27 06:00:51 +08:00
}
```
# js/output.js
2017-03-31 02:42:42 +08:00
<details><summary><code>/******/ (function(modules) { /* webpackBootstrap */ })</code></summary>
2012-03-27 06:00:51 +08:00
``` javascript
2013-03-28 17:31:52 +08:00
/******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
2017-03-31 02:25:01 +08:00
/******/
2013-03-28 17:31:52 +08:00
/******/ // The require function
2014-03-25 17:44:10 +08:00
/******/ function __webpack_require__(moduleId) {
2017-03-31 02:25:01 +08:00
/******/
2013-03-28 17:31:52 +08:00
/******/ // Check if module is in cache
2017-05-23 04:45:18 +08:00
/******/ if(installedModules[moduleId]) {
2014-03-25 17:44:10 +08:00
/******/ return installedModules[moduleId].exports;
2017-05-23 04:45:18 +08:00
/******/ }
2013-03-28 17:31:52 +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: {}
2013-03-28 17:31:52 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2013-03-28 17:31:52 +08:00
/******/ // Execute the module function
2014-03-25 17:44:10 +08:00
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
2017-03-31 02:25:01 +08:00
/******/
2013-03-28 17:31:52 +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
/******/
2013-03-28 17:31:52 +08:00
/******/ // Return the exports of the module
2014-03-25 17:44:10 +08:00
/******/ return module.exports;
2013-03-28 17:31:52 +08:00
/******/ }
2017-03-31 02:25:01 +08:00
/******/
/******/
2013-03-28 17:31:52 +08:00
/******/ // expose the modules object (__webpack_modules__)
2014-03-25 17:44:10 +08:00
/******/ __webpack_require__.m = modules;
2017-03-31 02:25:01 +08:00
/******/
2013-03-28 17:31:52 +08:00
/******/ // expose the module cache
2014-03-25 17:44:10 +08:00
/******/ __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
/******/
2013-12-16 06:30:50 +08:00
/******/ // __webpack_public_path__
2014-03-25 17:44:10 +08:00
/******/ __webpack_require__.p = "js/";
2017-03-31 02:25:01 +08:00
/******/
2013-03-28 17:31:52 +08:00
/******/ // Load entry module and return exports
2017-12-14 17:58:03 +08:00
/******/ return __webpack_require__(__webpack_require__.s = 0);
2013-03-28 17:31:52 +08:00
/******/ })
2013-03-27 01:22:30 +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
2013-12-16 06:30:50 +08:00
/******/ ([
/* 0 */
2017-03-31 02:25:01 +08:00
/*!********************!*\
!*** ./example.js ***!
\********************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports, __webpack_require__) {
// use our loader
2017-12-14 17:58:03 +08:00
console.dir(__webpack_require__(/*! ./loader!./file */ 1));
2017-03-31 02:25:01 +08:00
// use buildin css loader
2017-12-14 17:58:03 +08:00
console.dir(__webpack_require__(/*! ./test.css */ 2)); // default by extension
console.dir(__webpack_require__(/*! css-loader!./test.css */ 2)); // manual
2017-03-31 02:25:01 +08:00
2017-06-05 22:12:12 +08:00
/***/ }),
2017-12-14 17:58:03 +08:00
/* 1 */
2017-06-05 22:12:12 +08:00
/*!*****************************!*\
!*** ./loader.js!./file.js ***!
\*****************************/
/*! no static exports found */
/***/ (function(module, exports) {
exports.answer = 42;
exports.foo = "bar";
2017-12-14 17:58:03 +08:00
/***/ }),
/* 2 */
/*!****************************************************!*\
!*** (webpack)/node_modules/css-loader!./test.css ***!
\****************************************************/
/*! no static exports found */
/***/ (function(module, exports, __webpack_require__) {
exports = module.exports = __webpack_require__(/*! ../../node_modules/css-loader/lib/css-base.js */ 3)(undefined);
// imports
// module
exports.push([module.i, ".some-class {\r\n\tcolor: hotpink;\r\n}\r\n", ""]);
// exports
2017-03-31 02:25:01 +08:00
/***/ }),
/* 3 */
2017-06-05 22:12:12 +08:00
/*!*********************************************************!*\
!*** (webpack)/node_modules/css-loader/lib/css-base.js ***!
\*********************************************************/
/*! no static exports found */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports) {
2016-12-14 19:03:24 +08:00
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
// css base code, injected by the css-loader
2017-06-05 22:12:12 +08:00
module.exports = function(useSourceMap) {
2016-12-14 19:03:24 +08:00
var list = [];
// return the list of modules as css string
list.toString = function toString() {
2017-06-05 22:12:12 +08:00
return this.map(function (item) {
var content = cssWithMappingToString(item, useSourceMap);
2016-12-14 19:03:24 +08:00
if(item[2]) {
2017-06-05 22:12:12 +08:00
return "@media " + item[2] + "{" + content + "}";
2016-12-14 19:03:24 +08:00
} else {
2017-06-05 22:12:12 +08:00
return content;
2016-12-14 19:03:24 +08:00
}
2017-06-05 22:12:12 +08:00
}).join("");
2016-12-14 19:03:24 +08:00
};
// import a list of modules into the list
list.i = function(modules, mediaQuery) {
if(typeof modules === "string")
modules = [[null, modules, ""]];
var alreadyImportedModules = {};
for(var i = 0; i < this.length; i++) {
var id = this[i][0];
if(typeof id === "number")
alreadyImportedModules[id] = true;
}
for(i = 0; i < modules.length; i++) {
var item = modules[i];
// skip already imported module
// this implementation is not 100% perfect for weird media query combinations
// when a module is imported multiple times with different media queries.
// I hope this will never occur (Hey this way we have smaller bundles)
if(typeof item[0] !== "number" || !alreadyImportedModules[item[0]]) {
if(mediaQuery && !item[2]) {
item[2] = mediaQuery;
} else if(mediaQuery) {
item[2] = "(" + item[2] + ") and (" + mediaQuery + ")";
}
list.push(item);
}
}
};
return list;
};
2017-06-05 22:12:12 +08:00
function cssWithMappingToString(item, useSourceMap) {
var content = item[1] || '';
var cssMapping = item[3];
if (!cssMapping) {
return content;
}
if (useSourceMap && typeof btoa === 'function') {
var sourceMapping = toComment(cssMapping);
var sourceURLs = cssMapping.sources.map(function (source) {
return '/*# sourceURL=' + cssMapping.sourceRoot + source + ' */'
});
return [content].concat(sourceURLs).concat([sourceMapping]).join('\n');
}
return [content].join('\n');
}
// Adapted from convert-source-map (MIT)
function toComment(sourceMap) {
// eslint-disable-next-line no-undef
var base64 = btoa(unescape(encodeURIComponent(JSON.stringify(sourceMap))));
var data = 'sourceMappingURL=data:application/json;charset=utf-8;base64,' + base64;
return '/*# ' + data + ' */';
}
2016-12-14 19:03:24 +08:00
2017-03-31 02:25:01 +08:00
/***/ })
2015-06-13 23:41:14 +08:00
/******/ ]);
2012-03-27 06:00:51 +08:00
```
2012-03-27 10:23:11 +08:00
# Console output
2013-02-24 09:27:11 +08:00
Prints in node.js (`enhanced-require example.js`) and in browser:
2012-03-27 10:23:11 +08:00
```
{ answer: 42, foo: 'bar' }
{ foobar: 1234 }
{ foobar: 1234 }
```
2012-03-27 06:00:51 +08:00
# Info
2017-12-14 17:58:03 +08:00
## Unoptimized
2012-03-27 06:00:51 +08:00
```
2017-12-14 17:58:03 +08:00
Hash: 0a1b2c3d4e5f6a7b8c9d
2017-11-23 16:47:19 +08:00
Version: webpack next
2017-11-24 15:40:39 +08:00
Asset Size Chunks Chunk Names
2017-12-14 17:58:03 +08:00
output.js 6.19 KiB 0 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2017-11-23 16:47:19 +08:00
chunk {0} output.js (main) 2.66 KiB [entry] [rendered]
2017-12-14 17:58:03 +08:00
> main [0] ./example.js
[0] ./example.js 210 bytes {0} [built]
2017-11-23 16:47:19 +08:00
single entry .\example.js main
2017-12-14 17:58:03 +08:00
[1] ./loader.js!./file.js 41 bytes {0} [built]
cjs require ./loader!./file [0] ./example.js 2:12-38
[2] (webpack)/node_modules/css-loader!./test.css 209 bytes {0} [built]
cjs require !css-loader!./test.css [0] ./example.js 6:12-45
cjs require ./test.css [0] ./example.js 5:12-33
2017-08-08 20:00:06 +08:00
+ 1 hidden module
2013-12-16 06:30:50 +08:00
```
2017-12-14 17:58:03 +08:00
## Production mode
2013-12-16 06:30:50 +08:00
```
2017-12-14 17:58:03 +08:00
Hash: 0a1b2c3d4e5f6a7b8c9d
2017-11-23 16:47:19 +08:00
Version: webpack next
Asset Size Chunks Chunk Names
2017-12-14 17:58:03 +08:00
output.js 1.53 KiB 0 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2017-12-14 17:58:03 +08:00
chunk {0} output.js (main) 2.66 KiB [entry] [rendered]
2017-12-21 18:19:53 +08:00
> main [3] ./example.js
2017-12-14 17:58:03 +08:00
[0] (webpack)/node_modules/css-loader!./test.css 209 bytes {0} [built]
2017-12-21 18:19:53 +08:00
cjs require !css-loader!./test.css [3] ./example.js 6:12-45
cjs require ./test.css [3] ./example.js 5:12-33
2017-06-05 22:12:12 +08:00
[2] ./loader.js!./file.js 41 bytes {0} [built]
2017-12-21 18:19:53 +08:00
cjs require ./loader!./file [3] ./example.js 2:12-38
[3] ./example.js 210 bytes {0} [built]
single entry .\example.js main
2017-08-08 20:00:06 +08:00
+ 1 hidden module
2013-12-16 06:30:50 +08:00
```