forked from babel/babel-polyfills
/
index.js
395 lines (341 loc) · 10.2 KB
/
index.js
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
// @flow
import { declare } from "@babel/helper-plugin-utils";
import type { NodePath } from "@babel/traverse";
import getTargets, {
isRequired,
getInclusionReasons,
} from "@babel/helper-compilation-targets";
import { createUtilsGetter } from "./utils";
import ImportsCache from "./imports-cache";
import {
stringifyTargetsMultiline,
presetEnvSilentDebugHeader,
} from "./debug-utils";
import {
validateIncludeExclude,
applyMissingDependenciesDefaults,
} from "./normalize-options";
import type {
ProviderApi,
MethodString,
Targets,
MetaDescriptor,
PolyfillProvider,
PluginOptions,
ProviderOptions,
} from "./types";
import * as v from "./visitors";
import * as deps from "./node/dependencies";
import createMetaResolver from "./meta-resolver";
export type { PolyfillProvider, MetaDescriptor, Utils, Targets } from "./types";
function resolveOptions<Options>(
options: PluginOptions,
babelApi,
): {
method: MethodString,
methodName: "usageGlobal" | "entryGlobal" | "usagePure",
targets: Targets,
debug: boolean,
shouldInjectPolyfill: ?(name: string, shouldInject: boolean) => boolean,
providerOptions: ProviderOptions<Options>,
absoluteImports: string | boolean,
} {
const {
method,
targets: targetsOption,
ignoreBrowserslistConfig,
configPath,
debug,
shouldInjectPolyfill,
absoluteImports,
...providerOptions
} = options;
let methodName;
if (method === "usage-global") methodName = "usageGlobal";
else if (method === "entry-global") methodName = "entryGlobal";
else if (method === "usage-pure") methodName = "usagePure";
else if (typeof method !== "string") {
throw new Error(".method must be a string");
} else {
throw new Error(
`.method must be one of "entry-global", "usage-global"` +
` or "usage-pure" (received ${JSON.stringify(method)})`,
);
}
if (typeof shouldInjectPolyfill === "function") {
if (options.include || options.exclude) {
throw new Error(
`.include and .exclude are not supported when using the` +
` .shouldInjectPolyfill function.`,
);
}
} else if (shouldInjectPolyfill != null) {
throw new Error(
`.shouldInjectPolyfill must be a function, or undefined` +
` (received ${JSON.stringify(shouldInjectPolyfill)})`,
);
}
if (
absoluteImports != null &&
typeof absoluteImports !== "boolean" &&
typeof absoluteImports !== "string"
) {
throw new Error(
`.absoluteImports must be a boolean, a string, or undefined` +
` (received ${JSON.stringify(absoluteImports)})`,
);
}
let targets;
if (
// If any browserslist-related option is specified, fallback to the old
// behavior of not using the targets specified in the top-level options.
targetsOption ||
configPath ||
ignoreBrowserslistConfig
) {
const targetsObj =
typeof targetsOption === "string" || Array.isArray(targetsOption)
? { browsers: targetsOption }
: targetsOption;
targets = getTargets(targetsObj, {
ignoreBrowserslistConfig,
configPath,
});
} else {
targets = babelApi.targets();
}
return {
method,
methodName,
targets,
absoluteImports: absoluteImports ?? false,
shouldInjectPolyfill,
debug: !!debug,
providerOptions: ((providerOptions: Object): ProviderOptions<Options>),
};
}
function instantiateProvider<Options>(
factory: PolyfillProvider<Options>,
options: PluginOptions,
missingDependencies,
dirname,
debugLog,
babelApi,
) {
const {
method,
methodName,
targets,
debug,
shouldInjectPolyfill,
providerOptions,
absoluteImports,
} = resolveOptions<Options>(options, babelApi);
const getUtils = createUtilsGetter(
new ImportsCache(moduleName =>
deps.resolve(dirname, moduleName, absoluteImports),
),
);
// eslint-disable-next-line prefer-const
let include, exclude;
let polyfillsSupport;
let polyfillsNames;
let filterPolyfills;
const depsCache = new Map();
const api: ProviderApi = {
babel: babelApi,
getUtils,
method: options.method,
targets,
createMetaResolver,
shouldInjectPolyfill(name) {
if (polyfillsNames === undefined) {
throw new Error(
`Internal error in the ${factory.name} provider: ` +
`shouldInjectPolyfill() can't be called during initialization.`,
);
}
if (!polyfillsNames.has(name)) {
console.warn(
`Internal error in the ${provider.name} provider: ` +
`unknown polyfill "${name}".`,
);
}
if (filterPolyfills && !filterPolyfills(name)) return false;
let shouldInject = isRequired(name, targets, {
compatData: polyfillsSupport,
includes: include,
excludes: exclude,
});
if (shouldInjectPolyfill) {
shouldInject = shouldInjectPolyfill(name, shouldInject);
if (typeof shouldInject !== "boolean") {
throw new Error(`.shouldInjectPolyfill must return a boolean.`);
}
}
return shouldInject;
},
debug(name) {
debugLog().found = true;
if (!debug || !name) return;
if (debugLog().polyfills.has(provider.name)) return;
debugLog().polyfills.set(
name,
polyfillsSupport && name && polyfillsSupport[name],
);
},
assertDependency(name, version = "*") {
if (missingDependencies === false) return;
if (absoluteImports) {
// If absoluteImports is not false, we will try resolving
// the dependency and throw if it's not possible. We can
// skip the check here.
return;
}
const dep = version === "*" ? name : `${name}@^${version}`;
const found = missingDependencies.all
? false
: mapGetOr(depsCache, name, () => !deps.has(dirname, name));
if (!found) {
debugLog().missingDeps.add(dep);
}
},
};
const provider = factory(api, providerOptions, dirname);
if (typeof provider[methodName] !== "function") {
throw new Error(
`The "${provider.name || factory.name}" provider doesn't ` +
`support the "${method}" polyfilling method.`,
);
}
if (Array.isArray(provider.polyfills)) {
polyfillsNames = new Set(provider.polyfills);
filterPolyfills = provider.filterPolyfills;
} else if (provider.polyfills) {
polyfillsNames = new Set(Object.keys(provider.polyfills));
polyfillsSupport = provider.polyfills;
filterPolyfills = provider.filterPolyfills;
} else {
polyfillsNames = new Set();
}
({ include, exclude } = validateIncludeExclude(
provider.name || factory.name,
polyfillsNames,
providerOptions.include || [],
providerOptions.exclude || [],
));
return {
debug,
method,
targets,
provider,
callProvider(payload: MetaDescriptor, path: NodePath) {
const utils = getUtils(path);
// $FlowIgnore
provider[methodName](payload, utils, path);
},
};
}
export default function definePolyfillProvider<Options>(
factory: PolyfillProvider<Options>,
) {
return declare((babelApi, options: PluginOptions, dirname: string) => {
babelApi.assertVersion(7);
const { traverse } = babelApi;
let debugLog;
const missingDependencies = applyMissingDependenciesDefaults(
options,
babelApi,
);
const {
debug,
method,
targets,
provider,
callProvider,
} = instantiateProvider<Options>(
factory,
options,
missingDependencies,
dirname,
() => debugLog,
babelApi,
);
const createVisitor = method === "entry-global" ? v.entry : v.usage;
const visitor = provider.visitor
? traverse.visitors.merge([createVisitor(callProvider), provider.visitor])
: createVisitor(callProvider);
if (debug && debug !== presetEnvSilentDebugHeader) {
console.log(`${provider.name}: \`DEBUG\` option`);
console.log(`\nUsing targets: ${stringifyTargetsMultiline(targets)}`);
console.log(`\nUsing polyfills with \`${method}\` method:`);
}
return {
name: "inject-polyfills",
visitor,
pre() {
debugLog = {
polyfills: new Map(),
found: false,
providers: new Set(),
missingDeps: new Set(),
};
// $FlowIgnore - Flow doesn't support optional calls
provider.pre?.apply(this, arguments);
},
post() {
// $FlowIgnore - Flow doesn't support optional calls
provider.post?.apply(this, arguments);
if (missingDependencies !== false) {
if (missingDependencies.log === "per-file") {
deps.logMissing(debugLog.missingDeps);
} else {
deps.laterLogMissing(debugLog.missingDeps);
}
}
if (!debug) return;
if (this.filename) console.log(`\n[${this.filename}]`);
if (debugLog.polyfills.size === 0) {
console.log(
method === "entry-global"
? debugLog.found
? `Based on your targets, the ${provider.name} polyfill did not add any polyfill.`
: `The entry point for the ${provider.name} polyfill has not been found.`
: `Based on your code and targets, the ${provider.name} polyfill did not add any polyfill.`,
);
return;
}
if (method === "entry-global") {
console.log(
`The ${provider.name} polyfill entry has been replaced with ` +
`the following polyfills:`,
);
} else {
console.log(
`The ${provider.name} polyfill added the following polyfills:`,
);
}
for (const [name, support] of debugLog.polyfills) {
if (support) {
const filteredTargets = getInclusionReasons(name, targets, support);
const formattedTargets = JSON.stringify(filteredTargets)
.replace(/,/g, ", ")
.replace(/^\{"/, '{ "')
.replace(/"\}$/, '" }');
console.log(` ${name} ${formattedTargets}`);
} else {
console.log(` ${name}`);
}
}
},
};
});
}
function mapGetOr(map, key, getDefault) {
let val = map.get(key);
if (val === undefined) {
val = getDefault();
map.set(key, val);
}
return val;
}