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

Show more of this group Show more artifacts with this name
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.
There is a newer version: v20240317
Show newest version
/*
 * Copyright 2008 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.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;

import java.util.List;
import java.util.Map;

/**
 * Named groups of DiagnosticTypes exposed by Compiler.
 * @author [email protected] (Nick Santos)
 */
public class DiagnosticGroups {

  public DiagnosticGroups() {}

  private final static Map groupsByName =
      Maps.newHashMap();

  static DiagnosticGroup registerGroup(String name,
      DiagnosticGroup group) {
    groupsByName.put(name, group);
    return group;
  }

  /** Get the registered diagnostic groups, indexed by name. */
  protected Map getRegisteredGroups() {
    return ImmutableMap.copyOf(groupsByName);
  }

  /** Find the diagnostic group registered under the given name. */
  protected DiagnosticGroup forName(String name) {
    return groupsByName.get(name);
  }

  // A bit a hack to display the available groups on the command-line.
  // New groups should be added to this list if they are public and should
  // be listed on the command-line as an available option.
  static final String DIAGNOSTIC_GROUP_NAMES = 
      "accessControls, ambiguousFunctionDecl, checkRegExp," +
      "checkTypes, checkVars, deprecated, " +
      "externsValidation, fileoverviewTags, invalidCasts, " +
      "missingProperties, nonStandardJsDocs, strictModuleDepCheck, " +
      "undefinedVars, unknownDefines, uselessCode, visibility";

  public static DiagnosticGroup DEPRECATED = DiagnosticGroups
      .registerGroup("deprecated",
          new DiagnosticGroup(
              CheckAccessControls.DEPRECATED_NAME,
              CheckAccessControls.DEPRECATED_NAME_REASON,
              CheckAccessControls.DEPRECATED_PROP,
              CheckAccessControls.DEPRECATED_PROP_REASON,
              CheckAccessControls.DEPRECATED_CLASS,
              CheckAccessControls.DEPRECATED_CLASS_REASON));

  public static DiagnosticGroup VISIBILITY = DiagnosticGroups
      .registerGroup("visibility",
          new DiagnosticGroup(
              CheckAccessControls.BAD_PRIVATE_GLOBAL_ACCESS,
              CheckAccessControls.BAD_PRIVATE_PROPERTY_ACCESS,
              CheckAccessControls.BAD_PROTECTED_PROPERTY_ACCESS,
              CheckAccessControls.PRIVATE_OVERRIDE,
              CheckAccessControls.VISIBILITY_MISMATCH));

  public static DiagnosticGroup NON_STANDARD_JSDOC =
    DiagnosticGroups.registerGroup("nonStandardJsDocs",
          new DiagnosticGroup(RhinoErrorReporter.BAD_JSDOC_ANNOTATION));

  public static DiagnosticGroup ACCESS_CONTROLS =
      DiagnosticGroups.registerGroup("accessControls",
          new DiagnosticGroup(DEPRECATED, VISIBILITY));

  public static DiagnosticGroup INVALID_CASTS = DiagnosticGroups
      .registerGroup("invalidCasts",
          new DiagnosticGroup(TypeValidator.INVALID_CAST));

  public static DiagnosticGroup FILEOVERVIEW_JSDOC =
    DiagnosticGroups.registerGroup("fileoverviewTags",
          new DiagnosticGroup(RhinoErrorReporter.EXTRA_FILEOVERVIEW));

  public static DiagnosticGroup STRICT_MODULE_DEP_CHECK =
    DiagnosticGroups.registerGroup("strictModuleDepCheck",
          new DiagnosticGroup(VarCheck.STRICT_MODULE_DEP_ERROR,
                              CheckGlobalNames.STRICT_MODULE_DEP_QNAME));

  public static DiagnosticGroup EXTERNS_VALIDATION =
    DiagnosticGroups.registerGroup("externsValidation",
          new DiagnosticGroup(VarCheck.NAME_REFERENCE_IN_EXTERNS_ERROR,
                              VarCheck.UNDEFINED_EXTERN_VAR_ERROR));

  public static DiagnosticGroup AMBIGUOUS_FUNCTION_DECL =
    DiagnosticGroups.registerGroup("ambiguousFunctionDecl",
          new DiagnosticGroup(VariableReferenceCheck.AMBIGUOUS_FUNCTION_DECL));  

  public static DiagnosticGroup UNKNOWN_DEFINES =
    DiagnosticGroups.registerGroup("unknownDefines",
          new DiagnosticGroup(ProcessDefines.UNKNOWN_DEFINE_WARNING));

  public static DiagnosticGroup MISSING_PROPERTIES =
    DiagnosticGroups.registerGroup("missingProperties",
          new DiagnosticGroup(TypeCheck.INEXISTENT_PROPERTY));

  public static DiagnosticGroup UNDEFINED_VARIABLES =
      DiagnosticGroups.registerGroup("undefinedVars",
          new DiagnosticGroup(VarCheck.UNDEFINED_VAR_ERROR));

  public static DiagnosticGroup CHECK_REGEXP =
    DiagnosticGroups.registerGroup("checkRegExp",
        new DiagnosticGroup(
            CheckRegExp.REGEXP_REFERENCE));

  public static DiagnosticGroup CHECK_TYPES =
      DiagnosticGroups.registerGroup("checkTypes",
          new DiagnosticGroup(
              TypeValidator.ALL_DIAGNOSTICS,
              TypeCheck.ALL_DIAGNOSTICS));

  public static DiagnosticGroup CHECK_VARIABLES =
    DiagnosticGroups.registerGroup("checkVars",
        new DiagnosticGroup(
            VarCheck.UNDEFINED_VAR_ERROR,
            SyntacticScopeCreator.VAR_MULTIPLY_DECLARED_ERROR));

  public static DiagnosticGroup CHECK_USELESS_CODE =
    DiagnosticGroups.registerGroup("uselessCode",
        new DiagnosticGroup(
            CheckSideEffects.USELESS_CODE_ERROR,
            CheckUnreachableCode.UNREACHABLE_CODE)); 

  /**
   * Adds warning levels by name.
   */
  void setWarningLevels(CompilerOptions options,
      List diagnosticGroups, CheckLevel level) {
    for (String name : diagnosticGroups) {
      DiagnosticGroup group = forName(name);
      Preconditions.checkNotNull(group, "No warning class for name: " + name);
      options.setWarningLevel(group, level);
    }
  }
}