com.google.javascript.refactoring.JsFlumeCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of closure-compiler-linter 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. This binary checks for style issues such as incorrect or missing JSDoc usage, and missing goog.require() statements. It does not do more advanced checks such as typechecking.

There is a newer version: v20200830

Show newest version

/*
 * 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.base.Strings;
import com.google.javascript.jscomp.NodeTraversal;
import com.google.javascript.jscomp.NodeTraversal.Callback;
import com.google.javascript.rhino.Node;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import javax.annotation.Nullable;

/**
 * A compiler node traversal callback that invokes matchers against every node and
 * keeps track of any suggested fixes from the refactoring.
 */
final class JsFlumeCallback implements Callback {

  private final Scanner scanner;
  @Nullable
  private final Pattern includeFilePattern;
  private final List matches = new ArrayList<>();
  private final List fixes = new ArrayList<>();

  JsFlumeCallback(Scanner scanner, @Nullable Pattern includeFilePattern) {
    this.scanner = scanner;
    this.includeFilePattern = includeFilePattern;
  }

  List getMatches() {
    return matches;
  }

  List getFixes() {
    return fixes;
  }

  @Override
  public boolean shouldTraverse(NodeTraversal nodeTraversal, Node n, Node parent) {
    if (n.isFromExterns()) {
      return false;
    }
    if (n.isScript()) {
      String filename = n.getSourceFileName();
      if (includeFilePattern != null
          && !Strings.isNullOrEmpty(includeFilePattern.pattern())
          && !Strings.isNullOrEmpty(filename)) {
        return includeFilePattern.matcher(filename).find();
      }
    }
    return true;
  }

  @Override
  public void visit(NodeTraversal t, Node n, Node parent) {
    NodeMetadata metadata = NodeMetadata.fromTraversal(t);
    if (scanner.matches(n, metadata)) {
      Match match = new Match(n, metadata);
      fixes.addAll(scanner.processMatch(match));
      matches.add(match);
    }
  }
}