在 webpack 中将库配置为外部库不适用于 UMD 作为 libraryTarget
Configuring library as external in webpack does not work with UMD as libraryTarget
我最近两天试过这个，但我无法让它像预期的那样工作：
我想构建自己的 JavaScript 库并将其注册到一个已经存在的命名空间下（"OCA" - 在这种特殊情况下）。正如您可能理解的那样，我不想被迫放弃现代方法，例如通过打字稿或模块实现类型安全。
因此我使用 webpack 2 和 libraryTarget: umd 在 "OCA.Ocr" 下注册输出（我的库名为 "Ocr"）。这按预期工作，但是当涉及到我想使用的点时，例如 underscorejs，因为它将在应用程序中全局可用，库也应该交付给，我不能让它工作。
我遵循了 webpack 配置文档，它说 externals 配置选项应该是正确的选择：
externals: { // object
angular: "this angular", // this["angular"]
react: { // UMD
commonjs: "react",
commonjs2: "react",
amd: "react",
root: "React"
}
}
// Don't follow/bundle these modules, but request them at runtime from the environment
我按照指南的建议使用了它，但它不起作用：
/* global __dirname, require, module*/
const webpack = require("webpack");
const UglifyJsPlugin = webpack.optimize.UglifyJsPlugin;
const path = require("path");
module.exports = function (env) {
let target = env.target;
let libraryName = ["OCA", "Ocr"];
let plugins = [];
let outputFile;
if (target === "production") {
plugins.push(new UglifyJsPlugin({ minimize: true }));
}
outputFile = "ocr[name].min.js";
const config = {
entry: {
app: __dirname + "/src/app.ts",
personal: __dirname + "/src/personal.ts"
},
output: {
path: __dirname + "/dist",
filename: outputFile,
library: libraryName,
libraryTarget: "umd",
umdNamedDefine: true
},
module: {
rules: [
{
test: /\.ts$/,
enforce: "pre",
loader: "tslint-loader",
options: {
tsConfigFile: "tsconfig.app.json",
}
},
{
test: /\.ts?$/,
loader: "ts-loader",
exclude: /node_modules/,
options: {
configFileName: "tsconfig.app.json"
}
}
],
},
resolve: {
modules: [path.resolve("./src")],
extensions: [".ts"],
},
externals: {
underscore: { // UMD
commonjs: "underscore",
commonjs2: "underscore",
amd: "underscore",
root: "_"
}
},
plugins: plugins,
};
return config;
}
我的 app.ts 文件使用下划线库（例如 _.defer 方法，当然它并不总是最好用的）看起来像这样：
import _ from 'underscore';
export class App {
constructor() {
_.defer(() => {
console.log('test');
});
}
}
export let $app: App = new App();
我将它包含在应用程序中，并检查了 underscorejs 库是否在浏览器加载我的库之前加载，但控制台输出仍然显示：
TypeError: underscore_1.default is undefined
编译后的输出如下（也许这有点帮助）：
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object')
module.exports = factory(require("underscore"));
else if(typeof define === 'function' && define.amd)
define("Ocr", ["underscore"], factory);
else if(typeof exports === 'object')
exports["Ocr"] = factory(require("underscore"));
else
root["OCA"] = root["OCA"] || {}, root["OCA"]["Ocr"] = factory(root["_"]);
})(this, function(__WEBPACK_EXTERNAL_MODULE_1__) {
return /******/ (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;
/******/
/******/ // identity function for calling harmony imports with the correct context
/******/ __webpack_require__.i = function(value) { return value; };
/******/
/******/ // 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 = "";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = 2);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */,
/* 1 */
/***/ (function(module, exports) {
module.exports = __WEBPACK_EXTERNAL_MODULE_1__;
/***/ }),
/* 2 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var underscore_1 = __webpack_require__(1);
var App = (function () {
function App() {
underscore_1.default.defer(function () {
console.log('test');
});
}
return App;
}());
exports.App = App;
exports.$app = new App();
/***/ })
/******/ ]);
});
有谁知道这是如何工作的以及我必须做什么？我完全迷路了，现在希望得到你的帮助。
顺便说一句： 也不适合我。
我和你有同样的问题，但是，如果你在 libraryTarget 选项中设置 属性 var，变量将不再是未定义的。也许这会对你有所帮助：
externals: {
"lodash": {
var:'_'
}
}
这里有 2 个选项。我推荐选项#1。
事实上，如果您使用 UMD 并计划支持 node（除了 commonjs、amd 和浏览器），总是设置 globalObject: 'this'
将output.globalObject设置为this，并使用externals.root。
const config = {
output: {
library: libraryName,
libraryTarget: "umd",
globalObject: 'this' // <-- THIS IS THE IMPORTANT LINE FOR UMD+NODE
},
externals: {
underscore: { // UMD
commonjs: "underscore",
commonjs2: "underscore",
amd: "underscore",
root: "_"
}
},
};
output.globalObject
当以库为目标时，尤其是当 libraryTarget 为 'umd' 时，此选项指示将使用哪个全局对象来装载库。要使 UMD 构建在浏览器和 Node.js 上都可用，请将 output.globalObject 选项设置为 'this'。
使用 externals.var 代替 externals.root。
externals: {
underscore: { // UMD
commonjs: "underscore",
commonjs2: "underscore",
amd: "underscore",
var: "_"
}
},
这是一个解决方法，不需要设置globalObject: 'this'
我最近两天试过这个，但我无法让它像预期的那样工作： 我想构建自己的 JavaScript 库并将其注册到一个已经存在的命名空间下（"OCA" - 在这种特殊情况下）。正如您可能理解的那样，我不想被迫放弃现代方法，例如通过打字稿或模块实现类型安全。
因此我使用 webpack 2 和 libraryTarget: umd 在 "OCA.Ocr" 下注册输出（我的库名为 "Ocr"）。这按预期工作，但是当涉及到我想使用的点时，例如 underscorejs，因为它将在应用程序中全局可用，库也应该交付给，我不能让它工作。
我遵循了 webpack 配置文档，它说 externals 配置选项应该是正确的选择：
externals: { // object
angular: "this angular", // this["angular"]
react: { // UMD
commonjs: "react",
commonjs2: "react",
amd: "react",
root: "React"
}
}
// Don't follow/bundle these modules, but request them at runtime from the environment
我按照指南的建议使用了它，但它不起作用：
/* global __dirname, require, module*/
const webpack = require("webpack");
const UglifyJsPlugin = webpack.optimize.UglifyJsPlugin;
const path = require("path");
module.exports = function (env) {
let target = env.target;
let libraryName = ["OCA", "Ocr"];
let plugins = [];
let outputFile;
if (target === "production") {
plugins.push(new UglifyJsPlugin({ minimize: true }));
}
outputFile = "ocr[name].min.js";
const config = {
entry: {
app: __dirname + "/src/app.ts",
personal: __dirname + "/src/personal.ts"
},
output: {
path: __dirname + "/dist",
filename: outputFile,
library: libraryName,
libraryTarget: "umd",
umdNamedDefine: true
},
module: {
rules: [
{
test: /\.ts$/,
enforce: "pre",
loader: "tslint-loader",
options: {
tsConfigFile: "tsconfig.app.json",
}
},
{
test: /\.ts?$/,
loader: "ts-loader",
exclude: /node_modules/,
options: {
configFileName: "tsconfig.app.json"
}
}
],
},
resolve: {
modules: [path.resolve("./src")],
extensions: [".ts"],
},
externals: {
underscore: { // UMD
commonjs: "underscore",
commonjs2: "underscore",
amd: "underscore",
root: "_"
}
},
plugins: plugins,
};
return config;
}
我的 app.ts 文件使用下划线库（例如 _.defer 方法，当然它并不总是最好用的）看起来像这样：
import _ from 'underscore';
export class App {
constructor() {
_.defer(() => {
console.log('test');
});
}
}
export let $app: App = new App();
我将它包含在应用程序中，并检查了 underscorejs 库是否在浏览器加载我的库之前加载，但控制台输出仍然显示：
TypeError: underscore_1.default is undefined
编译后的输出如下（也许这有点帮助）：
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object')
module.exports = factory(require("underscore"));
else if(typeof define === 'function' && define.amd)
define("Ocr", ["underscore"], factory);
else if(typeof exports === 'object')
exports["Ocr"] = factory(require("underscore"));
else
root["OCA"] = root["OCA"] || {}, root["OCA"]["Ocr"] = factory(root["_"]);
})(this, function(__WEBPACK_EXTERNAL_MODULE_1__) {
return /******/ (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;
/******/
/******/ // identity function for calling harmony imports with the correct context
/******/ __webpack_require__.i = function(value) { return value; };
/******/
/******/ // 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 = "";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = 2);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */,
/* 1 */
/***/ (function(module, exports) {
module.exports = __WEBPACK_EXTERNAL_MODULE_1__;
/***/ }),
/* 2 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var underscore_1 = __webpack_require__(1);
var App = (function () {
function App() {
underscore_1.default.defer(function () {
console.log('test');
});
}
return App;
}());
exports.App = App;
exports.$app = new App();
/***/ })
/******/ ]);
});
有谁知道这是如何工作的以及我必须做什么？我完全迷路了，现在希望得到你的帮助。
顺便说一句：
我和你有同样的问题，但是，如果你在 libraryTarget 选项中设置 属性 var，变量将不再是未定义的。也许这会对你有所帮助：
externals: {
"lodash": {
var:'_'
}
}
这里有 2 个选项。我推荐选项#1。
事实上，如果您使用 UMD 并计划支持 node（除了 commonjs、amd 和浏览器），总是设置 globalObject: 'this'
将output.globalObject设置为this，并使用externals.root。
const config = {
output: {
library: libraryName,
libraryTarget: "umd",
globalObject: 'this' // <-- THIS IS THE IMPORTANT LINE FOR UMD+NODE
},
externals: {
underscore: { // UMD
commonjs: "underscore",
commonjs2: "underscore",
amd: "underscore",
root: "_"
}
},
};
output.globalObject
当以库为目标时，尤其是当 libraryTarget 为 'umd' 时，此选项指示将使用哪个全局对象来装载库。要使 UMD 构建在浏览器和 Node.js 上都可用，请将 output.globalObject 选项设置为 'this'。
使用 externals.var 代替 externals.root。
externals: {
underscore: { // UMD
commonjs: "underscore",
commonjs2: "underscore",
amd: "underscore",
var: "_"
}
},
这是一个解决方法，不需要设置globalObject: 'this'