webpack/examples/loader/README.md

282 lines
8.1 KiB
Markdown
Raw Normal View History

2012-03-27 06:00:51 +08:00
# example.js
2019-04-09 02:29:40 +08:00
```javascript
2012-03-27 06:00:51 +08:00
// 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
2019-04-09 02:29:40 +08:00
```javascript
2012-03-27 06:00:51 +08:00
exports.foo = "bar";
```
# loader.js
2019-04-09 02:29:40 +08:00
```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
2019-04-09 02:29:40 +08:00
```css
.some-class {
color: hotpink;
2012-03-27 06:00:51 +08:00
}
```
# dist/output.js
2012-03-27 06:00:51 +08:00
2019-04-09 02:29:40 +08:00
```javascript
2019-10-09 05:45:47 +08:00
/******/ ((modules, runtime) => { // webpackBootstrap
2018-12-19 21:05:17 +08:00
/******/ "use strict";
2013-03-28 17:31:52 +08:00
/******/ // 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
2019-10-09 05:45:47 +08:00
/******/ modules[moduleId](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
/******/
/******/
2019-02-05 01:52:39 +08:00
/******/ // the startup function
/******/ function startup() {
/******/ // Load entry module and return exports
/******/ return __webpack_require__(0);
2018-09-25 23:08:35 +08:00
/******/ };
/******/
2019-02-05 01:52:39 +08:00
/******/ // run startup
/******/ return startup();
2013-03-28 17:31:52 +08:00
/******/ })
2013-03-27 01:22:30 +08:00
/************************************************************************/
2013-12-16 06:30:50 +08:00
/******/ ([
/* 0 */
2017-03-31 02:25:01 +08:00
/*!********************!*\
!*** ./example.js ***!
\********************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
2018-12-19 21:05:17 +08:00
/*! runtime requirements: __webpack_require__ */
2019-10-09 05:45:47 +08:00
/***/ ((__unusedmodule, __unusedexports, __webpack_require__) => {
2017-03-31 02:25:01 +08:00
// 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 ***!
\*****************************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
2018-12-19 21:05:17 +08:00
/*! runtime requirements: __webpack_exports__ */
2019-10-09 05:45:47 +08:00
/***/ ((__unusedmodule, exports) => {
2017-06-05 22:12:12 +08:00
exports.answer = 42;
exports.foo = "bar";
2017-12-14 17:58:03 +08:00
/***/ }),
/* 2 */
/*!****************************************************************!*\
!*** (webpack)/node_modules/css-loader/dist/cjs.js!./test.css ***!
\****************************************************************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
/*! runtime requirements: __webpack_exports__, module, __webpack_require__ */
2019-10-09 05:45:47 +08:00
/***/ ((module, exports, __webpack_require__) => {
2017-12-14 17:58:03 +08:00
exports = module.exports = __webpack_require__(/*! ../../node_modules/css-loader/dist/runtime/api.js */ 3)(false);
// Module
2018-09-25 23:08:35 +08:00
exports.push([module.i, ".some-class {\n\tcolor: hotpink;\n}\n", ""]);
2017-12-14 17:58:03 +08:00
2017-03-31 02:25:01 +08:00
/***/ }),
/* 3 */
/*!*************************************************************!*\
!*** (webpack)/node_modules/css-loader/dist/runtime/api.js ***!
\*************************************************************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
2018-12-19 21:05:17 +08:00
/*! runtime requirements: module */
2019-10-09 05:45:47 +08:00
/***/ ((module) => {
2016-12-14 19:03:24 +08:00
"use strict";
2016-12-14 19:03:24 +08:00
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
2016-12-14 19:03:24 +08:00
*/
// css base code, injected by the css-loader
2019-10-09 05:45:47 +08:00
// eslint-disable-next-line func-names
module.exports = function (useSourceMap) {
var list = []; // return the list of modules as css string
list.toString = function toString() {
return this.map(function (item) {
var content = cssWithMappingToString(item, useSourceMap);
if (item[2]) {
2019-10-09 05:45:47 +08:00
return "@media ".concat(item[2], "{").concat(content, "}");
}
2019-10-09 05:45:47 +08:00
return content;
}).join('');
}; // import a list of modules into the list
2019-10-09 05:45:47 +08:00
// eslint-disable-next-line func-names
list.i = function (modules, mediaQuery) {
if (typeof modules === 'string') {
2019-10-09 05:45:47 +08:00
// eslint-disable-next-line no-param-reassign
modules = [[null, modules, '']];
}
var alreadyImportedModules = {};
for (var i = 0; i < this.length; i++) {
2019-10-09 05:45:47 +08:00
// eslint-disable-next-line prefer-destructuring
var id = this[i][0];
if (id != null) {
alreadyImportedModules[id] = true;
}
}
2019-10-09 05:45:47 +08:00
for (var _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 (item[0] == null || !alreadyImportedModules[item[0]]) {
if (mediaQuery && !item[2]) {
item[2] = mediaQuery;
} else if (mediaQuery) {
2019-10-09 05:45:47 +08:00
item[2] = "(".concat(item[2], ") and (").concat(mediaQuery, ")");
}
list.push(item);
}
}
};
return list;
2016-12-14 19:03:24 +08:00
};
2017-06-05 22:12:12 +08:00
function cssWithMappingToString(item, useSourceMap) {
2019-10-09 05:45:47 +08:00
var content = item[1] || ''; // eslint-disable-next-line prefer-destructuring
var cssMapping = item[3];
2017-06-05 22:12:12 +08:00
if (!cssMapping) {
return content;
}
2017-06-05 22:12:12 +08:00
if (useSourceMap && typeof btoa === 'function') {
var sourceMapping = toComment(cssMapping);
var sourceURLs = cssMapping.sources.map(function (source) {
2019-10-09 05:45:47 +08:00
return "/*# sourceURL=".concat(cssMapping.sourceRoot).concat(source, " */");
});
return [content].concat(sourceURLs).concat([sourceMapping]).join('\n');
}
return [content].join('\n');
} // Adapted from convert-source-map (MIT)
2017-06-05 22:12:12 +08:00
function toComment(sourceMap) {
// eslint-disable-next-line no-undef
var base64 = btoa(unescape(encodeURIComponent(JSON.stringify(sourceMap))));
2019-10-09 05:45:47 +08:00
var data = "sourceMappingURL=data:application/json;charset=utf-8;base64,".concat(base64);
return "/*# ".concat(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
2019-10-09 05:45:47 +08:00
Version: webpack 5.0.0-alpha.30
2018-09-25 23:08:35 +08:00
Asset Size Chunks Chunk Names
2019-10-09 05:45:47 +08:00
output.js 5.64 KiB {0} [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2019-10-09 05:45:47 +08:00
chunk {0} output.js (main) 3.03 KiB [entry] [rendered]
2019-01-25 20:15:22 +08:00
> ./example.js main
2018-09-25 23:08:35 +08:00
[0] ./example.js 204 bytes {0} [built]
2018-09-26 05:13:58 +08:00
[used exports unknown]
2019-02-05 01:52:39 +08:00
entry ./example.js main
2018-05-07 18:36:38 +08:00
[1] ./loader.js!./file.js 41 bytes {0} [built]
2018-09-26 05:13:58 +08:00
[used exports unknown]
2018-05-07 18:36:38 +08:00
cjs require ./loader!./file [0] ./example.js 2:12-38
2019-10-09 05:45:47 +08:00
[2] (webpack)/node_modules/css-loader/dist/cjs.js!./test.css 178 bytes {0} [built]
2018-09-26 05:13:58 +08:00
[used exports unknown]
2018-05-07 18:36:38 +08:00
cjs require ./test.css [0] ./example.js 5:12-33
2018-09-25 23:08:35 +08:00
cjs require !css-loader!./test.css [0] ./example.js 6:12-45
2019-10-09 05:45:47 +08:00
[3] (webpack)/node_modules/css-loader/dist/runtime/api.js 2.61 KiB {0} [built]
2018-12-19 21:05:17 +08:00
[used exports unknown]
2019-05-10 03:34:28 +08:00
cjs require ../../node_modules/css-loader/dist/runtime/api.js [2] (webpack)/node_modules/css-loader/dist/cjs.js!./test.css 1:27-87
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
2019-10-09 05:45:47 +08:00
Version: webpack 5.0.0-alpha.30
2017-11-23 16:47:19 +08:00
Asset Size Chunks Chunk Names
2019-10-09 05:45:47 +08:00
output.js 1.21 KiB {179} [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2019-10-09 05:45:47 +08:00
chunk {179} output.js (main) 3.03 KiB [entry] [rendered]
2019-01-25 20:15:22 +08:00
> ./example.js main
2019-10-09 05:45:47 +08:00
[90] (webpack)/node_modules/css-loader/dist/cjs.js!./test.css 178 bytes {179} [built]
2019-05-10 03:34:28 +08:00
cjs require ./test.css [144] ./example.js 5:12-33
cjs require !css-loader!./test.css [144] ./example.js 6:12-45
[144] ./example.js 204 bytes {179} [built]
2019-02-05 01:52:39 +08:00
entry ./example.js main
2019-05-10 03:34:28 +08:00
[232] ./loader.js!./file.js 41 bytes {179} [built]
cjs require ./loader!./file [144] ./example.js 2:12-38
2019-10-09 05:45:47 +08:00
[609] (webpack)/node_modules/css-loader/dist/runtime/api.js 2.61 KiB {179} [built]
2019-05-10 03:34:28 +08:00
cjs require ../../node_modules/css-loader/dist/runtime/api.js [90] (webpack)/node_modules/css-loader/dist/cjs.js!./test.css 1:27-87
2013-12-16 06:30:50 +08:00
```