com.google.javascript.jscomp.Result Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of closure-compiler-unshaded 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.

There is a newer version: v20240317

Show newest version

/*
 * Copyright 2009 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 com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import java.util.Set;
import org.jspecify.nullness.Nullable;

/** Compilation results */
public class Result {
  public final boolean success;
  public final ImmutableList errors;
  public final ImmutableList warnings;

  public final VariableMap variableMap;
  public final VariableMap propertyMap;
  public final VariableMap namedAnonFunctionMap;
  public final VariableMap stringMap;
  public final VariableMap instrumentationMappings;
  public final SourceMap sourceMap;
  public final Map cssNames;
  public final String externExport;
  public final String idGeneratorMap;
  public final Set transpiledFiles;

  Result(
      ImmutableList errors,
      ImmutableList warnings,
      VariableMap variableMap,
      VariableMap propertyMap,
      VariableMap namedAnonFunctionMap,
      @Nullable VariableMap stringMap,
      @Nullable VariableMap instrumentationMappings,
      @Nullable SourceMap sourceMap,
      String externExport,
      @Nullable Map cssNames,
      @Nullable String idGeneratorMap,
      @Nullable Set transpiledFiles) {
    this.success = errors.isEmpty();
    this.errors = errors;
    this.warnings = warnings;
    this.variableMap = variableMap;
    this.propertyMap = propertyMap;
    this.namedAnonFunctionMap = namedAnonFunctionMap;
    this.stringMap = stringMap;
    this.instrumentationMappings = instrumentationMappings;
    this.sourceMap = sourceMap;
    this.externExport = externExport;
    this.cssNames = cssNames;
    this.idGeneratorMap = idGeneratorMap;
    this.transpiledFiles = transpiledFiles;
  }

  @VisibleForTesting
  @Deprecated
  public Result(
      ImmutableList errors,
      ImmutableList warnings,
      VariableMap variableMap,
      VariableMap propertyMap,
      VariableMap namedAnonFunctionMap,
      SourceMap sourceMap,
      String externExport) {
    this(
        errors,
        warnings,
        variableMap,
        propertyMap,
        namedAnonFunctionMap,
        /* stringMap= */ null,
        /* instrumentationMappings= */ null,
        sourceMap,
        externExport,
        /* cssNames= */ null,
        /* idGeneratorMap= */ null,
        /* transpiledFiles= */ null);
  }

  /**
   * Returns an almost empty result that is more appropriate for a partial compilation.
   *
   * For a partial compilation we only care about errors and warnings. It is unnecessary to
   * examine all of the other results.
   *
   * @param result the full `Result` object provided by the compiler
   */
  public static Result pruneResultForPartialCompilation(Result result) {
    VariableMap emptyVariableMap = new VariableMap(ImmutableMap.of());
    return new Result(
        /* errors= */ result.errors,
        /* warnings= */ result.warnings,
        /* variableMap= */ emptyVariableMap,
        /* propertyMap= */ emptyVariableMap,
        /* namedAnonFunctionMap= */ emptyVariableMap,
        /* stringMap= */ null,
        /* instrumentationMappings= */ emptyVariableMap,
        /* sourceMap= */ null,
        /* externExport= */ "",
        /* cssNames= */ null,
        /* idGeneratorMap= */ null,
        /* transpiledFiles= */ null);
  }
}