-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
TranspilationPasses.java
585 lines (513 loc) · 20.4 KB
/
TranspilationPasses.java
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/*
* Copyright 2016 The Closure Compiler Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.javascript.jscomp;
import static com.google.javascript.jscomp.parsing.parser.FeatureSet.ES2018;
import static com.google.javascript.jscomp.parsing.parser.FeatureSet.ES6;
import static com.google.javascript.jscomp.parsing.parser.FeatureSet.ES7;
import static com.google.javascript.jscomp.parsing.parser.FeatureSet.ES8;
import static com.google.javascript.jscomp.parsing.parser.FeatureSet.ES8_MODULES;
import static com.google.javascript.jscomp.parsing.parser.FeatureSet.ES_NEXT;
import com.google.javascript.jscomp.NodeTraversal.Callback;
import com.google.javascript.jscomp.PassFactory.HotSwapPassFactory;
import com.google.javascript.jscomp.parsing.parser.FeatureSet;
import com.google.javascript.jscomp.parsing.parser.FeatureSet.Feature;
import com.google.javascript.rhino.Node;
import java.util.List;
/**
* Provides a single place to manage transpilation passes.
*/
public class TranspilationPasses {
private TranspilationPasses() {}
public static void addEs6ModulePass(
List<PassFactory> passes,
final PreprocessorSymbolTable.CachedInstanceFactory preprocessorTableFactory) {
passes.add(
new HotSwapPassFactory("es6RewriteModule") {
@Override
protected HotSwapCompilerPass create(AbstractCompiler compiler) {
preprocessorTableFactory.maybeInitialize(compiler);
return new Es6RewriteModules(
compiler,
preprocessorTableFactory.getInstanceOrNull(),
compiler.getOptions().processCommonJSModules,
compiler.getOptions().moduleResolutionMode);
}
@Override
protected FeatureSet featureSet() {
return ES_NEXT;
}
});
}
public static void addPreTypecheckTranspilationPasses(
List<PassFactory> passes, CompilerOptions options) {
addPreTypecheckTranspilationPasses(
passes,
options,
// This condition works most of the time, but has edge cases that fail in tests.
!options.skipNonTranspilationPasses);
}
// TODO(mattmm): eliminate need for this boolean
// Tests extending CompilerTestCase and TypeCheckTestCase fail if the es6ExternsCheck pass is
// run. Ideally a condition based on the CompilerOptions should be used so that the boolean
// parameter can be removed.
static void addPreTypecheckTranspilationPasses(
List<PassFactory> passes, CompilerOptions options, boolean doEs6ExternsCheck) {
if (options.needsTranspilationFrom(ES2018)) {
passes.add(rewriteObjRestSpread);
}
if (options.needsTranspilationFrom(ES8)) {
// Trailing commas in parameter lists are flagged as present by the parser,
// but never actually represented in the AST.
// The only thing we need to do is mark them as not present in the AST.
passes.add(
createFeatureRemovalPass(
"markTrailingCommasInParameterListsRemoved", Feature.TRAILING_COMMA_IN_PARAM_LIST));
passes.add(rewriteAsyncFunctions);
}
if (options.needsTranspilationFrom(ES7)) {
passes.add(convertEs7ToEs6);
}
if (options.needsTranspilationFrom(ES6)) {
if (doEs6ExternsCheck) {
passes.add(es6ExternsCheck);
}
// Binary and octal literals are effectively transpiled by the parser.
// There's no transpilation we can do for the new regexp flags.
passes.add(
createFeatureRemovalPass(
"markEs6FeaturesNotRequiringTranspilationAsRemoved",
Feature.BINARY_LITERALS,
Feature.OCTAL_LITERALS,
Feature.REGEXP_FLAG_U,
Feature.REGEXP_FLAG_Y));
passes.add(es6NormalizeShorthandProperties);
passes.add(es6ConvertSuper);
passes.add(es6RenameVariablesInParamLists);
passes.add(es6SplitVariableDeclarations);
passes.add(es6RewriteDestructuring);
passes.add(es6RewriteArrowFunction);
passes.add(es6ExtractClasses);
passes.add(es6RewriteClass);
passes.add(es6InjectRuntimeLibraries);
if (!options.checksOnly) {
// Don't run these passes in checksOnly mode since all the typechecking & checks passes
// support the transpiled features.
// TODO(b/73387406): Move each pass above here temporarily, then into
// addEs6PostCheck Passes once the pass supports propagating type information
}
}
}
public static void addEs6ModuleToCjsPass(List<PassFactory> passes) {
passes.add(es6RewriteModuleToCjs);
}
public static void addEs6RewriteImportPathPass(List<PassFactory> passes) {
passes.add(es6RelativizeImportPaths);
}
/** Deprecated: use addPostCheckTranspilationPasses instead. */
@Deprecated
public static void addPostTypecheckTranspilationPasses(List<PassFactory> passes) {}
/** Adds transpilation passes that should run after all checks are done. */
public static void addPostCheckTranspilationPasses(List<PassFactory> passes) {
// TODO(b/73387406): Move passes here as typechecking & other check passes are updated to cope
// with the features they transpile and as the passes themselves are updated to propagate type
// information to the transpiled code.
passes.add(es6RewriteRestAndSpread);
passes.add(lateConvertEs6ToEs3);
passes.add(es6ForOf);
passes.add(rewriteBlockScopedFunctionDeclaration);
passes.add(rewriteBlockScopedDeclaration);
passes.add(rewriteGenerators);
passes.add(es6ConvertSuperConstructorCalls);
}
/**
* Adds the pass to inject ES6 polyfills, which goes after the late ES6 passes.
*/
public static void addRewritePolyfillPass(List<PassFactory> passes) {
passes.add(rewritePolyfills);
}
/** Rewrites ES6 modules */
private static final PassFactory es6RewriteModuleToCjs =
new PassFactory("es6RewriteModuleToCjs", true) {
@Override
protected CompilerPass create(AbstractCompiler compiler) {
return new Es6RewriteModulesToCommonJsModules(compiler);
}
@Override
protected FeatureSet featureSet() {
return FeatureSet.latest();
}
};
/** Rewrites ES6 modules import paths to be browser compliant */
private static final PassFactory es6RelativizeImportPaths =
new PassFactory("es6RelativizeImportPaths", true) {
@Override
protected CompilerPass create(AbstractCompiler compiler) {
return new Es6RelativizeImportPaths(compiler);
}
@Override
protected FeatureSet featureSet() {
return FeatureSet.latest();
}
};
private static final PassFactory rewriteAsyncFunctions =
new HotSwapPassFactory("rewriteAsyncFunctions") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new RewriteAsyncFunctions(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
private static final PassFactory rewriteObjRestSpread =
new HotSwapPassFactory("rewriteObjRestSpread") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new EsNextToEs8Converter(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES_NEXT;
}
};
private static final PassFactory convertEs7ToEs6 =
new HotSwapPassFactory("convertEs7ToEs6") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es7RewriteExponentialOperator(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
private static final HotSwapPassFactory es6NormalizeShorthandProperties =
new HotSwapPassFactory("es6NormalizeShorthandProperties") {
@Override
protected HotSwapCompilerPass create(AbstractCompiler compiler) {
return new Es6NormalizeShorthandProperties(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final PassFactory es6ExternsCheck =
new PassFactory("es6ExternsCheck", true) {
@Override
protected CompilerPass create(final AbstractCompiler compiler) {
// TODO (mattmm): Investigate if this can be removed
return new Es6ExternsCheck(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8_MODULES;
}
};
static final HotSwapPassFactory es6ExtractClasses =
new HotSwapPassFactory(PassNames.ES6_EXTRACT_CLASSES) {
@Override
protected HotSwapCompilerPass create(AbstractCompiler compiler) {
return new Es6ExtractClasses(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory es6RewriteClass =
new HotSwapPassFactory("Es6RewriteClass") {
@Override
protected HotSwapCompilerPass create(AbstractCompiler compiler) {
return new Es6RewriteClass(compiler, true);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory es6RewriteDestructuring =
new HotSwapPassFactory("Es6RewriteDestructuring") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6RewriteDestructuring(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory es6RenameVariablesInParamLists =
new HotSwapPassFactory("Es6RenameVariablesInParamLists") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6RenameVariablesInParamLists(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory es6RewriteArrowFunction =
new HotSwapPassFactory("Es6RewriteArrowFunction") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6RewriteArrowFunction(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory rewritePolyfills =
new HotSwapPassFactory("RewritePolyfills") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new RewritePolyfills(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8_MODULES;
}
};
static final HotSwapPassFactory es6SplitVariableDeclarations =
new HotSwapPassFactory("Es6SplitVariableDeclarations") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6SplitVariableDeclarations(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory es6ConvertSuperConstructorCalls =
new HotSwapPassFactory("es6ConvertSuperConstructorCalls") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6ConvertSuperConstructorCalls(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory es6ConvertSuper =
new HotSwapPassFactory("es6ConvertSuper") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6ConvertSuper(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
/** Injects runtime library code needed for transpiled ES6 code. */
static final HotSwapPassFactory es6InjectRuntimeLibraries =
new HotSwapPassFactory("es6InjectRuntimeLibraries") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6InjectRuntimeLibraries(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
/** Transpiles REST parameters and SPREAD in both array literals and function calls. */
static final HotSwapPassFactory es6RewriteRestAndSpread =
new HotSwapPassFactory("es6RewriteRestAndSpread") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6RewriteRestAndSpread(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
/**
* Does the main ES6 to ES3 conversion. There are a few other passes which run before this one, to
* convert constructs which are not converted by this pass. This pass can run after NTI
*/
static final HotSwapPassFactory lateConvertEs6ToEs3 =
new HotSwapPassFactory("lateConvertEs6") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new LateEs6ToEs3Converter(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory es6ForOf =
new HotSwapPassFactory("es6ForOf") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6ForOfConverter(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory rewriteBlockScopedFunctionDeclaration =
new HotSwapPassFactory("Es6RewriteBlockScopedFunctionDeclaration") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6RewriteBlockScopedFunctionDeclaration(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory rewriteBlockScopedDeclaration =
new HotSwapPassFactory("Es6RewriteBlockScopedDeclaration") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6RewriteBlockScopedDeclaration(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
static final HotSwapPassFactory rewriteGenerators =
new HotSwapPassFactory("rewriteGenerators") {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new Es6RewriteGenerators(compiler);
}
@Override
protected FeatureSet featureSet() {
return ES8;
}
};
/**
* @param script The SCRIPT node representing a JS file
* @return If the file has any features which are part of ES6 or higher but not part of ES5.
*/
static boolean isScriptEs6OrHigher(Node script) {
FeatureSet features = NodeUtil.getFeatureSetOfScript(script);
return features != null && !FeatureSet.ES5.contains(features);
}
/**
* @param script The SCRIPT node representing a JS file
* @return If the file has any features not in {@code supportedFeatures}
*/
static boolean doesScriptHaveUnsupportedFeatures(Node script, FeatureSet supportedFeatures) {
FeatureSet features = NodeUtil.getFeatureSetOfScript(script);
return features != null && !supportedFeatures.contains(features);
}
/**
* Process transpilations if the input language needs transpilation from certain features, on any
* JS file that has features not present in the compiler's output language mode.
*
* @param compiler An AbstractCompiler
* @param combinedRoot The combined root for all JS files.
* @param featureSet The features which this pass helps transpile.
* @param callbacks The callbacks that should be invoked if a file has ES6 features.
*/
static void processTranspile(
AbstractCompiler compiler, Node combinedRoot, FeatureSet featureSet, Callback... callbacks) {
if (compiler.getOptions().needsTranspilationFrom(featureSet)) {
FeatureSet languageOutFeatures = compiler.getOptions().getOutputFeatureSet();
for (Node singleRoot : combinedRoot.children()) {
// Only run the transpilation if this file has features not in the compiler's target output
// language. For example, if this file is purely ES6 and the output language is ES6, don't
// run any transpilation passes on it.
// TODO(lharker): We could save time by being more selective about what files we transpile.
// e.g. if a file has async functions but not `**`, don't run `**` transpilation on it.
// Right now we know what features were in a file at parse time, but not what features were
// added to that file by other transpilation passes.
if (doesScriptHaveUnsupportedFeatures(singleRoot, languageOutFeatures)) {
for (Callback callback : callbacks) {
singleRoot.putBooleanProp(Node.TRANSPILED, true);
NodeTraversal.traverse(compiler, singleRoot, callback);
}
}
}
}
}
/**
* Hot-swap ES6+ transpilations if the input language needs transpilation from certain features,
* on any JS file that has features not present in the compiler's output language mode.
*
* @param compiler An AbstractCompiler
* @param scriptRoot The SCRIPT root for the JS file.
* @param featureSet The features which this pass helps transpile.
* @param callbacks The callbacks that should be invoked if the file has ES6 features.
*/
static void hotSwapTranspile(
AbstractCompiler compiler, Node scriptRoot, FeatureSet featureSet, Callback... callbacks) {
if (compiler.getOptions().needsTranspilationFrom(featureSet)) {
FeatureSet languageOutFeatures = compiler.getOptions().getOutputFeatureSet();
if (doesScriptHaveUnsupportedFeatures(scriptRoot, languageOutFeatures)) {
for (Callback callback : callbacks) {
scriptRoot.putBooleanProp(Node.TRANSPILED, true);
NodeTraversal.traverse(compiler, scriptRoot, callback);
}
}
}
}
static void maybeMarkFeaturesAsTranspiledAway(
AbstractCompiler compiler, FeatureSet transpiledFeatures) {
// We don't bother to do this if the compiler has halting errors, which avoids unnecessary
// warnings from AstValidator warning that the features are still there.
if (!compiler.hasHaltingErrors()) {
compiler.setFeatureSet(compiler.getFeatureSet().without(transpiledFeatures));
}
}
static void maybeMarkFeaturesAsTranspiledAway(
AbstractCompiler compiler, Feature transpiledFeature, Feature... moreTranspiledFeatures) {
if (!compiler.hasHaltingErrors()) {
compiler.setFeatureSet(
compiler.getFeatureSet().without(transpiledFeature, moreTranspiledFeatures));
}
}
/**
* Returns a pass that just removes features from the AST FeatureSet.
*
* <p>Doing this indicates that the AST no longer contains uses of the features, or that they are
* no longer of concern for some other reason.
*/
private static HotSwapPassFactory createFeatureRemovalPass(
String passName, final Feature featureToRemove, final Feature... moreFeaturesToRemove) {
return new HotSwapPassFactory(passName) {
@Override
protected HotSwapCompilerPass create(final AbstractCompiler compiler) {
return new HotSwapCompilerPass() {
@Override
public void hotSwapScript(Node scriptRoot, Node originalRoot) {
maybeMarkFeaturesAsTranspiledAway(compiler, featureToRemove, moreFeaturesToRemove);
}
@Override
public void process(Node externs, Node root) {
maybeMarkFeaturesAsTranspiledAway(compiler, featureToRemove, moreFeaturesToRemove);
}
};
}
@Override
protected FeatureSet featureSet() {
return FeatureSet.latest();
}
};
}
}