-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
RefactoringDriver.java
188 lines (159 loc) · 6.19 KB
/
RefactoringDriver.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
/*
* Copyright 2014 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.refactoring;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Function;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.javascript.jscomp.parsing.Config;
import com.google.javascript.jscomp.CheckLevel;
import com.google.javascript.jscomp.Compiler;
import com.google.javascript.jscomp.CompilerOptions;
import com.google.javascript.jscomp.CompilerOptions.LanguageMode;
import com.google.javascript.jscomp.DependencyOptions;
import com.google.javascript.jscomp.DiagnosticGroups;
import com.google.javascript.jscomp.NodeTraversal;
import com.google.javascript.jscomp.SourceFile;
import com.google.javascript.rhino.Node;
import java.util.List;
import java.util.regex.Pattern;
/**
* Primary driver of a refactoring. This class collects the inputs, runs the refactoring over
* the compiled input, and then collects the suggested fixes based on the refactoring.
*
* @author mknichel@google.com (Mark Knichel)
*/
public final class RefactoringDriver {
private final Scanner scanner;
private final Compiler compiler;
private final Node rootNode;
private RefactoringDriver(
Scanner scanner,
List<SourceFile> inputs,
List<SourceFile> externs,
CompilerOptions compilerOptions) {
this.scanner = scanner;
this.compiler = createCompiler(inputs, externs, compilerOptions);
this.rootNode = this.compiler.getRoot();
}
/**
* Run the refactoring and return any suggested fixes as a result.
*/
public List<SuggestedFix> drive(Pattern includeFilePattern) {
JsFlumeCallback callback = new JsFlumeCallback(scanner, includeFilePattern);
NodeTraversal.traverseEs6(compiler, rootNode, callback);
List<SuggestedFix> fixes = callback.getFixes();
fixes.addAll(scanner.processAllMatches(callback.getMatches()));
return fixes;
}
/**
* Run the refactoring and return any suggested fixes as a result.
*/
public List<SuggestedFix> drive() {
return drive(null);
}
public Compiler getCompiler() {
return compiler;
}
private Compiler createCompiler(
List<SourceFile> inputs, List<SourceFile> externs, CompilerOptions compilerOptions) {
Compiler compiler = new Compiler();
compiler.disableThreads();
compiler.compile(externs, inputs, compilerOptions);
return compiler;
}
// TODO(tbreisacher): Make this package-private by refactoring tests so they
// don't need to call it directly.
@VisibleForTesting
public static CompilerOptions getCompilerOptions() {
CompilerOptions options = new CompilerOptions();
options.setLanguageIn(LanguageMode.ECMASCRIPT6);
options.setLanguageOut(LanguageMode.ECMASCRIPT5);
options.setSummaryDetailLevel(0);
DependencyOptions deps = new DependencyOptions();
deps.setDependencySorting(true);
options.setDependencyOptions(deps);
options.setChecksOnly(true);
options.setContinueAfterErrors(true);
options.setParseJsDocDocumentation(Config.JsDocParsing.INCLUDE_DESCRIPTIONS_NO_WHITESPACE);
options.setCheckSuspiciousCode(true);
options.setCheckSymbols(true);
options.setCheckTypes(true);
options.setClosurePass(true);
options.setGenerateExports(true);
options.setPreserveGoogProvidesAndRequires(true);
options.setWarningLevel(DiagnosticGroups.MISSING_REQUIRE, CheckLevel.ERROR);
return options;
}
public static class Builder {
private static final Function<String, SourceFile> TO_SOURCE_FILE_FN =
new Function<String, SourceFile>() {
@Override public SourceFile apply(String file) {
return new SourceFile.Builder().buildFromFile(file);
}
};
private final Scanner scanner;
private final ImmutableList.Builder<SourceFile> inputs = ImmutableList.builder();
private final ImmutableList.Builder<SourceFile> externs = ImmutableList.builder();
private CompilerOptions compilerOptions = getCompilerOptions();
public Builder(Scanner scanner) {
this.scanner = scanner;
}
public Builder addExternsFromFile(String filename) {
externs.add(SourceFile.fromFile(filename));
return this;
}
public Builder addExternsFromCode(String code) {
externs.add(SourceFile.fromCode("externs", code));
return this;
}
public Builder addExterns(Iterable<SourceFile> externs) {
this.externs.addAll(externs);
return this;
}
public Builder addExternsFromFile(Iterable<String> externs) {
this.externs.addAll(Lists.transform(ImmutableList.copyOf(externs), TO_SOURCE_FILE_FN));
return this;
}
public Builder addInputsFromFile(String filename) {
inputs.add(SourceFile.fromFile(filename));
return this;
}
public Builder addInputsFromCode(String code) {
return addInputsFromCode(code, "input");
}
public Builder addInputsFromCode(String code, String filename) {
inputs.add(SourceFile.fromCode(filename, code));
return this;
}
public Builder addInputs(Iterable<SourceFile> inputs) {
this.inputs.addAll(inputs);
return this;
}
public Builder addInputsFromFile(Iterable<String> inputs) {
this.inputs.addAll(Lists.transform(ImmutableList.copyOf(inputs), TO_SOURCE_FILE_FN));
return this;
}
public Builder withCompilerOptions(CompilerOptions compilerOptions) {
this.compilerOptions = Preconditions.checkNotNull(compilerOptions);
return this;
}
public RefactoringDriver build() {
return new RefactoringDriver(scanner, inputs.build(), externs.build(), compilerOptions);
}
}
}