io.codemodder.Runner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of codemodder-base Show documentation

Base framework for writing codemods in Java

There is a newer version: 0.97.9

package io.codemodder;

import java.io.PrintWriter;
import java.util.List;
import picocli.CommandLine;

/** Provides an entrypoint for CLIs built with the codemodder framework. */
public final class Runner {

  private Runner() {}

  /**
   * Runs the codemods with a set of customized streams.
   *
   * @param codemods the codemods to run
   * @param args the arguments to pass to the codemod runner
   * @param stdout alternate stdout to use, or {@code null} to use the default
   * @param stderr alternate stderr to use, or {@code null} to use the default
   * @return the exit code of the codemodder CLI
   */
  public static int run(
      final List> codemods,
      final String[] args,
      final PrintWriter stdout,
      final PrintWriter stderr) {
    CommandLine commandLine =
        new CommandLine(new CLI(args, codemods)).setCaseInsensitiveEnumValuesAllowed(true);
    if (stdout != null) {
      commandLine.setOut(stdout);
    }
    if (stderr != null) {
      commandLine.setErr(stderr);
    }
    return commandLine.execute(args);
  }

  /**
   * Runs the given codemods with CLI arguments you get from a main() method. This is the most like
   * entry point you want to use.
   *
   * @see #run(List, String[], PrintWriter, PrintWriter)
   */
  public static void run(final List> codemods, final String[] args) {
    final int code = run(codemods, args, null, null);
    // we honor a special exit code (-1) that tells us not to exit, this is useful for integration
    // tests
    if (code != -1) {
      System.exit(code);
    }
  }
}