1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362# Moduloze: UMD Conversion Guide
This guide builds [on the Overview Example from the top-level conversion guide](conversion-guide.md#overview-example).
## Conversion Overview Example: UMD
`./src/test.js`:
```js
var Whatever = require("./src/whatever.js");
var { Something } = require("./src/something.js");
var anotherVal = require("./src/another.js").another();
module.exports.whatever = Whatever();
Object.assign(module.exports,{
Something,
Another: anotherVal,
});
```
Let's take a look at the UMD output produced, in two separate parts: the auto-generated UMD wrapper boilerplate, and the conversion of the `./src/test.js` module's code.
### UMD Wrapper
First, the UMD wrapper:
```js
(function UMD(name, context, dependencies, definition) {
if (typeof define === "function" && define.amd) {
dependencies = Object.keys(dependencies).map(p => p.replace(/^\.\//, ""));
define(name, dependencies, definition);
} else if (typeof module !== "undefined" && module.exports) {
dependencies = Object.keys(dependencies).map(p => require(p));
module.exports = definition(...dependencies);
} else {
dependencies = Object.values(dependencies).map(n => context[n]);
context[name] = definition(...dependencies);
}
})("TestModule", typeof globalThis != "undefined" ? globalThis : typeof global != "undefined" ? global : typeof window != "undefined" ? window : typeof self != "undefined" ? self : new Function("return this")(), {
"./src/whatever.js": "Whatever",
"./src/something.js": "Mz_540737562",
"./src/another.js": "Another"
}, function DEF(Whatever, Mz_540737562, Another) {
// ..
});
```
In this UMD wrapper, first notice that `TestModule` is the exported name for this overall module. That name came from the dependency-map (`depMap`) in the configuration for the build, as shown [in the Overview Example](#conversion-guide.md#overview-example). Moreover, the names `Whatever` and `Another` are used for the `./src/whatever.js` and `./src/another.js` modules, respectively; again these names come from `depMap`.
However, `./src/something.js` isn't listed in the dependency map (it probably should be!), so it's treated as an *unknown dependency*. Normally, that would throw an error, but in this case it doesn't because the config included `ignoreUnknownDependency: true`. It still has to have a name, so the name `Mz_540737562` was randomly generated for it, and will be used throughout all files in this current build run for any matching `./src/something.js` dependency import.
The UMD wrapper ensures this module will load properly in all of the following environments:
* Node.js (if you didn't want to use the original CJS, for some reason)
* A browser, using an AMD-style loader such as [RequireJS](https://requirejs.org/)
* A browser, using normal `<script src=..>` style loading, or a basic script loader (ie, [LABjs](https://github.com/getify/LABjs))
### Converted Module
Now, let's look at the `./src/test.js` module's converted code:
```js
var {
Something
} = Mz_540737562;
let anotherVal = Another.another();
let _exp2 = {};
_exp2.whatever = Whatever();
Object.assign(_exp2, {
Something,
Another: anotherVal
});
return _exp2;
```
Let's break that conversion down.
#### Converted Imports
The UMD wrapper automatically takes care of the entirety of a default import, like the first `Whatever` import; that statement is effectively removed (having been replaced by just the `Whatever` named parameter -- see the UMD wrapper boilerplate).
The named import for `Something` is computed against the imported module binding (auto-named `Mz_540737562` above).
And the computation of `anotherVal` is performed against the imported `Another` module binding.
#### Converted Exports
All assignments to `module.exports` are rewritten to be performed against an auto-generated variable (`_exp2` above), such as `_exp2.whatever = ..`, including other non-obvious assignment computations/expressions, like the `Object.assign(..)`.
Finally, the `_exp2` intermediary is returned as the single exported value for the module.
## Other Conversion Variations
Let's also explore a variety of other forms of import and export conversion.
### Import Forms
When `require("..")` is encountered in the original source, the UMD wrapper takes care of loading this dependency, and setting it into the scope of the UMD module (via parameter) by its dependency name, or is auto-generated (like `Mz_43812323`), if unknown.
**Note:** In the following snippets, `DependencyName` stands in for this identifier (whether by its configured name, or auto-generated).
```js
require("..");
// handled by the UMD wrapper
```
```js
var x = require("..");
// handled by the UMD wrapper
```
```js
// var x = ..
x = require("..");
// converts to:
x = DependencyName;
```
**Note:**
```js
var x = require("..").something;
// converts to:
var x = DependencyName.something;
```
```js
// var x = ..
x = require("..").something;
// converts to:
x = DependencyName.something;
```
```js
var { something } = require("..");
// converts to:
var { something } = DependencyName;
```
```js
var { something: x } = require("..");
// converts to:
var { something: x } = DependencyName;
```
```js
// var something = ..
({ something } = require(".."));
// converts to:
({ something } = DependencyName);
```
```js
// var x = ..
({ something: x } = require(".."));
// converts to:
({ something: x } = DependencyName);
```
```js
var x = require("..").something(42);
// converts to:
var x = DependencyName.something(42);
```
```js
// var x = ..
x = require("..").something(42);
// converts to:
x = DependencyName.something(42);
```
```js
var x = require("..")(42);
// converts to:
var x = DependencyName(42);
```
```js
// var x = ..
x = require("..")(42);
// converts to:
x = DependencyName(42);
```
```js
something( require("..") );
// converts to:
something( DependencyName );
```
### Export Forms
In all the following forms, `module.exports` is recognized the same as just `exports`, so they're interchangeable in the conversion.
In UMD builds, any operations against `module.exports` are actually performed against an auto-generated substitute (ie, `_exp`), and then at the end of the module, a `return _exp` is inserted.
**Note:** multiple assignments to `module.exports` (ie, `module.exports = ..`, not just `module.exports.x = ..`) are *permitted* in UMD builds. However, you should avoid this, as it's creating confusion by overriding earlier assignments. In the ESM build format, an exception will be thrown, because multiple default exports are not allowed by ESM. It *is* however common (and fine!) to have a single assignment to `module.exports` and then subsequently assign additional properties (ie, `module.exports.x = ..`).
```js
module.exports = something;
// converts to:
let _exp = {};
// ..
_exp = something;
//..
return _exp;
```
```js
module.exports = 42;
// converts to:
let _exp = {};
// ..
_exp = 42;
// ..
return _exp;
```
```js
module.exports = something(42);
// converts to:
let _exp = {};
// ..
_exp = something(42);
// ..
return _exp;
```
```js
module.exports = function something() { .. };
// converts to:
let _exp = {};
// ..
_exp = function something() { .. };
// ..
return _exp;
```
```js
module.exports.x = something;
// converts to:
let _exp = {};
// ..
_exp.x = something;
// ..
return _exp;
```
```js
module.exports.x = something.y;
// converts to:
let _exp = {};
// ..
_exp.x = something.y;
// ..
return _exp;
```
```js
module.exports.x = 42;
// converts to:
let _exp = {};
// ..
_exp.x = 42;
// ..
return _exp;
```
```js
module.exports.x = function something() { .. };
// converts to:
let _exp = {};
// ..
_exp.x = function something() { .. };
// ..
return _exp;
```
```js
Object.assign(module.exports,{
something() { .. },
x: 42
});
// converts to:
let _exp = {};
// ..
Object.assign(_exp,{
something() { .. },
x: 42
});
// ..
return _exp;
```
```js
something(module.exports);
// converts to:
let _exp = {};
// ..
something(_exp);
// ..
return _exp;
```
### Import + Export Forms
The combined import/export forms in UMD builds act like compositions of the above conversions, as there's no specific handling to combine them.