com.google.errorprone.DocGenTool Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of error_prone_docgen Show documentation
There is a newer version: 2.36.0
/*
 * Copyright 2015 The Error Prone 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.errorprone;

import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static com.google.common.io.Files.asCharSource;
import static com.google.errorprone.scanner.BuiltInCheckerSuppliers.ENABLED_ERRORS;
import static com.google.errorprone.scanner.BuiltInCheckerSuppliers.ENABLED_WARNINGS;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.beust.jcommander.IStringConverter;
import com.beust.jcommander.JCommander;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.google.common.base.Ascii;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import java.io.IOException;
import java.io.Writer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;
import java.util.stream.StreamSupport;

/**
 * Utility main which consumes the same tab-delimited text file and generates GitHub pages for the
 * BugPatterns.
 */
public final class DocGenTool {

  @Parameters(separators = "=")
  static class Options {
    @Parameter(names = "-bug_patterns", description = "Path to bugPatterns.txt", required = true)
    private String bugPatterns;

    @Parameter(
        names = "-explanations",
        description = "Path to side-car explanations",
        required = true)
    private String explanations;

    @Parameter(names = "-docs_repository", description = "Path to docs repository", required = true)
    private String docsRepository;

    @Parameter(
        names = "-target",
        description = "Whether to target the internal or external site",
        converter = TargetEnumConverter.class,
        required = true)
    private Target target;

    @Parameter(
        names = "-base_url",
        description = "The base url for links to bugpatterns",
        arity = 1)
    private String baseUrl = null;
  }

  enum Target {
    INTERNAL,
    EXTERNAL
  }

  public static class TargetEnumConverter implements IStringConverter {
    @Override
    public Target convert(String arg) {
      return Target.valueOf(Ascii.toUpperCase(arg));
    }
  }

  public static void main(String[] args) throws IOException {
    Options options = new Options();
    new JCommander(options).parse(args);

    Path bugPatterns = Paths.get(options.bugPatterns);
    if (!Files.exists(bugPatterns)) {
      usage("Cannot find bugPatterns file: " + options.bugPatterns);
    }
    Path explanationDir = Paths.get(options.explanations);
    if (!Files.exists(explanationDir)) {
      usage("Cannot find explanations dir: " + options.explanations);
    }
    Path wikiDir = Paths.get(options.docsRepository);
    Files.createDirectories(wikiDir);
    Path bugpatternDir = wikiDir.resolve("bugpattern");
    if (!Files.exists(bugpatternDir)) {
      Files.createDirectories(bugpatternDir);
    }
    Files.createDirectories(wikiDir.resolve("_data"));
    BugPatternFileGenerator generator =
        new BugPatternFileGenerator(
            bugpatternDir,
            explanationDir,
            options.target == Target.EXTERNAL,
            options.baseUrl,
            input -> input.severity);
    try (Writer w =
        Files.newBufferedWriter(wikiDir.resolve("bugpatterns.md"), StandardCharsets.UTF_8)) {
      List patterns =
          asCharSource(bugPatterns.toFile(), UTF_8).readLines(generator);
      new BugPatternIndexWriter().dump(patterns, w, options.target, enabledCheckNames());
    }
  }

  private static ImmutableSet enabledCheckNames() {
    return StreamSupport.stream(
            Iterables.concat(ENABLED_ERRORS, ENABLED_WARNINGS).spliterator(), false)
        .map(BugCheckerInfo::canonicalName)
        .collect(toImmutableSet());
  }

  private static void usage(String err) {
    System.err.println(err);
    System.exit(1);
  }

  private DocGenTool() {}
}