Skip to content

Commit 3e3b748

Browse files
sokrasokra
authored
Merge pull request webpack#4883 from AndersDJohnson/library-target-umd-names-per-target
feat: library target UMD supports names per target
2 parents 25a904b + 913b18b commit 3e3b748

5 files changed

Lines changed: 128 additions & 10 deletions

File tree

‎lib/UmdMainTemplatePlugin.js‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,17 @@ function accessorAccess(base, accessor) {
2323

2424
class UmdMainTemplatePlugin {
2525
constructor(name, options) {
26-
this.name = name;
26+
if(typeof name === "object" && !Array.isArray(name)) {
27+
this.name = name.root || name.amd || name.commonjs;
28+
this.names = name;
29+
} else {
30+
this.name = name;
31+
this.names = {
32+
commonjs: name,
33+
root: name,
34+
amd: name
35+
};
36+
}
2737
this.optionalAmdExternalAsGlobal = options.optionalAmdExternalAsGlobal;
2838
this.namedDefine = options.namedDefine;
2939
this.auxiliaryComment = options.auxiliaryComment;
@@ -125,16 +135,16 @@ class UmdMainTemplatePlugin {
125135
) +
126136
" else if(typeof define === 'function' && define.amd)\n" +
127137
(requiredExternals.length > 0 ?
128-
(this.name && this.namedDefine === true ?
129-
" define(" + libraryName(this.name) + ", " + externalsDepsArray(requiredExternals) + ", " + amdFactory + ");\n" :
138+
(this.names.amd && this.namedDefine === true ?
139+
" define(" + libraryName(this.names.amd) + ", " + externalsDepsArray(requiredExternals) + ", " + amdFactory + ");\n" :
130140
" define(" + externalsDepsArray(requiredExternals) + ", " + amdFactory + ");\n"
131141
) :
132-
(this.name && this.namedDefine === true ?
133-
" define(" + libraryName(this.name) + ", [], " + amdFactory + ");\n" :
142+
(this.names.amd && this.namedDefine === true ?
143+
" define(" + libraryName(this.names.amd) + ", [], " + amdFactory + ");\n" :
134144
" define([], " + amdFactory + ");\n"
135145
)
136146
) +
137-
(this.name ?
147+
(this.names.root || this.names.commonjs ?
138148
(this.auxiliaryComment &&
139149
typeof this.auxiliaryComment === "string" ?
140150
" //" + this.auxiliaryComment + "\n" :
@@ -143,7 +153,7 @@ class UmdMainTemplatePlugin {
143153
""
144154
) +
145155
" else if(typeof exports === 'object')\n" +
146-
" exports[" + libraryName(this.name) + "] = factory(" + externalsRequireArray("commonjs") + ");\n" +
156+
" exports[" + libraryName(this.names.commonjs || this.names.root) + "] = factory(" + externalsRequireArray("commonjs") + ");\n" +
147157
(this.auxiliaryComment &&
148158
typeof this.auxiliaryComment === "string" ?
149159
" //" + this.auxiliaryComment + "\n" :
@@ -152,7 +162,7 @@ class UmdMainTemplatePlugin {
152162
""
153163
) +
154164
" else\n" +
155-
" " + replaceKeys(accessorAccess("root", this.name)) + " = factory(" + externalsRootArray(externals) + ");\n" :
165+
" " + replaceKeys(accessorAccess("root", this.names.root || this.names.commonjs)) + " = factory(" + externalsRootArray(externals) + ");\n" :
156166
" else {\n" +
157167
(externals.length > 0 ?
158168
" var a = typeof exports === 'object' ? factory(" + externalsRequireArray("commonjs") + ") : factory(" + externalsRootArray(externals) + ");\n" :
@@ -164,12 +174,16 @@ class UmdMainTemplatePlugin {
164174
"})(this, function(" + externalsArguments(externals) + ") {\nreturn ", "webpack/universalModuleDefinition"), source, ";\n})");
165175
}.bind(this));
166176
mainTemplate.plugin("global-hash-paths", function(paths) {
167-
if(this.name) paths = paths.concat(this.name);
177+
if(this.names.root) paths = paths.concat(this.names.root);
178+
if(this.names.amd) paths = paths.concat(this.names.amd);
179+
if(this.names.commonjs) paths = paths.concat(this.names.commonjs);
168180
return paths;
169181
}.bind(this));
170182
mainTemplate.plugin("hash", function(hash) {
171183
hash.update("umd");
172-
hash.update(`${this.name}`);
184+
hash.update(`${this.names.root}`);
185+
hash.update(`${this.names.amd}`);
186+
hash.update(`${this.names.commonjs}`);
173187
}.bind(this));
174188
}
175189
}

‎schemas/webpackOptionsSchema.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,14 @@
375375
"type": "string"
376376
},
377377
"type": "array"
378+
},
379+
{
380+
"type": "object",
381+
"properties": {
382+
"root": { "type": "string" },
383+
"amd": { "type": "string" },
384+
"commonjs": { "type": "string" }
385+
}
378386
}
379387
],
380388
"description": "If set, export the bundle as library. `output.library` is the name."

‎test/LibraryTemplatePlugin.test.js‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,89 @@ describe("LibraryTemplatePlugin", function() {
318318
});
319319
});
320320
});
321+
322+
describe("name is an object of names per target", function() {
323+
[{
324+
type: "umd",
325+
namedDefine: true,
326+
assertion: function(compilationContext) {
327+
compilationContext.name.should.be.exactly("barRoot");
328+
compilationContext.names.should.deepEqual({
329+
root: "barRoot",
330+
amd: "bar-amd"
331+
});
332+
compilationContext.optionalAmdExternalAsGlobal.should.be.false();
333+
compilationContext.namedDefine.should.be.exactly(true);
334+
compilationContext.auxiliaryComment.should.be.exactly("baz");
335+
}
336+
},
337+
{
338+
type: "umd",
339+
namedDefine: false,
340+
assertion: function(compilationContext) {
341+
compilationContext.name.should.be.exactly("barRoot");
342+
compilationContext.names.should.deepEqual({
343+
root: "barRoot",
344+
amd: "bar-amd"
345+
});
346+
compilationContext.optionalAmdExternalAsGlobal.should.be.false();
347+
compilationContext.namedDefine.should.be.exactly(false);
348+
compilationContext.auxiliaryComment.should.be.exactly("baz");
349+
}
350+
},
351+
{
352+
type: "umd2",
353+
namedDefine: true,
354+
assertion: function(compilationContext) {
355+
compilationContext.name.should.be.exactly("barRoot");
356+
compilationContext.names.should.deepEqual({
357+
root: "barRoot",
358+
amd: "bar-amd"
359+
});
360+
compilationContext.optionalAmdExternalAsGlobal.should.be.true();
361+
compilationContext.namedDefine.should.be.exactly(true);
362+
compilationContext.auxiliaryComment.should.be.exactly("baz");
363+
}
364+
},
365+
{
366+
type: "umd2",
367+
namedDefine: false,
368+
assertion: function(compilationContext) {
369+
compilationContext.name.should.be.exactly("barRoot");
370+
compilationContext.names.should.deepEqual({
371+
root: "barRoot",
372+
amd: "bar-amd"
373+
});
374+
compilationContext.optionalAmdExternalAsGlobal.should.be.true();
375+
compilationContext.namedDefine.should.be.exactly(false);
376+
compilationContext.auxiliaryComment.should.be.exactly("baz");
377+
}
378+
}
379+
].forEach(function(targetTypeAndAssertion) {
380+
var type = targetTypeAndAssertion.type;
381+
var namedDefine = targetTypeAndAssertion.namedDefine;
382+
383+
describe("when target is " + type, function() {
384+
beforeEach(function() {
385+
env.eventBindings = applyPluginWithOptions(LibraryTemplatePlugin, {
386+
root: "barRoot",
387+
amd: "bar-amd"
388+
}, type, namedDefine, "baz");
389+
env.eventBinding = env.eventBindings[0];
390+
env.eventBinding.handler(env.compilation);
391+
});
392+
393+
it("compilation callback is called", function() {
394+
env.compilation.callCount.should.be.exactly(1);
395+
});
396+
397+
it("compilation callback context is set up", function() {
398+
var compilationContext = env.compilation.firstCall.thisValue;
399+
targetTypeAndAssertion.assertion(compilationContext);
400+
});
401+
});
402+
});
403+
});
321404
});
322405
});
323406
});

‎test/configCases/library/umd/index.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
it("should run", function() {
2+
3+
});

‎test/configCases/library/umd/webpack.config.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
module.exports = {
2+
output: {
3+
libraryTarget: "umd",
4+
library: {
5+
root: "testLibrary",
6+
amd: "test-library",
7+
commonjs: "test-library"
8+
}
9+
}
10+
};

0 commit comments

Comments
 (0)