com.google.javascript.jscomp.ConformanceAllowlister Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of closure-compiler Show documentation
Show all versions of closure-compiler Show documentation
Closure Compiler is a JavaScript optimizing compiler. It parses your
JavaScript, analyzes it, removes dead code and rewrites and minimizes
what's left. It also checks syntax, variable references, and types, and
warns about common JavaScript pitfalls. It is used in many of Google's
JavaScript apps, including Gmail, Google Web Search, Google Maps, and
Google Docs.
/*
* Copyright 2018 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.common.collect.ImmutableSet.toImmutableSet;
import com.google.common.annotations.GwtIncompatible;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.javascript.jscomp.Requirement.Severity;
import com.google.javascript.rhino.Node;
/** Creates or updates conformance allowlist/whitelist entries. */
@GwtIncompatible("Conformance")
public class ConformanceAllowlister {
private ConformanceAllowlister() {}
public static ImmutableSet getViolatingPaths(
Compiler compiler, Node externs, Node ast, Requirement requirement) {
return getConformanceErrors(compiler, externs, ast, requirement).stream()
.map(JSError::getSourceName)
.collect(toImmutableSet());
}
public static ImmutableSet getViolatingNodes(
Compiler compiler, Node externs, Node ast, Requirement requirement) {
return getConformanceErrors(compiler, externs, ast, requirement).stream()
.map(JSError::getNode)
.collect(toImmutableSet());
}
public static ImmutableList getConformanceErrors(
Compiler compiler, Node externs, Node ast, Requirement requirement) {
Requirement cleanedRequirement =
requirement.toBuilder()
.clearWhitelist()
.clearAllowlist()
.clearWhitelistRegexp()
.clearAllowlistRegexp()
.clearWhitelistEntry()
.clearAllowlistEntry()
.setSeverity(Severity.ERROR)
.build(); // So we only have one type of error.
ConformanceConfig cleanedConfig =
ConformanceConfig.newBuilder().addRequirement(cleanedRequirement).build();
ErrorManager oldErrorManager = compiler.getErrorManager();
final ImmutableList.Builder errors = ImmutableList.builder();
try {
// TODO(bangert): handle invalid conformance requirements
compiler.setErrorManager(
new ThreadSafeDelegatingErrorManager(oldErrorManager) {
@Override
public synchronized boolean shouldReportConformanceViolation(
Requirement requirement,
Optional whitelistEntry,
JSError diagnostic) {
errors.add(diagnostic);
return false;
}
});
CheckConformance check = new CheckConformance(compiler, ImmutableList.of(cleanedConfig));
check.process(externs, ast);
} finally {
compiler.setErrorManager(oldErrorManager);
}
return errors.build();
}
}