dev.dimlight.maven.plugin.shellcheck

Class Shellcheck

java.lang.Object

dev.dimlight.maven.plugin.shellcheck.Shellcheck

public class Shellcheck
extends Object

A thin java wrapper over the shellcheck binary for execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shellcheck.Result The results of a shellcheck run.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION The version of shellcheck that is embedded in the plugin jar.

Method Summary

Modifier and Type	Method and Description
static Shellcheck.Result	run(String runId, Path shellcheckBinary, List<String> args, List<Path> scriptsToCheck, Path capturedStdout, Path capturedStderr) Runs the provided shellcheck binary capturing its output and return code.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

The version of shellcheck that is embedded in the plugin jar.

See Also:

Constant Field Values

Method Detail

run

public static Shellcheck.Result run(String runId,
                                    Path shellcheckBinary,
                                    List<String> args,
                                    List<Path> scriptsToCheck,
                                    Path capturedStdout,
                                    Path capturedStderr)
                             throws IOException,
                                    InterruptedException

Runs the provided shellcheck binary capturing its output and return code.

Parameters:

runId - a string label used to mark the output stdout/stderr files for the run.

shellcheckBinary - the binary for shellcheck

args - the command line args to be passed to the shellcheck binary

scriptsToCheck - the list of arguments to shellcheck

capturedStdout - the path where the captured stdout should be redirected

capturedStderr - the path where the captured stderr should be redirected

Returns:

a result object containing exit code and captured outputs (on file)

Throws:

IOException - if something goes bad doing io things (writing files etc...)

InterruptedException - if the thread gets interrupted while waiting for shellcheck to finish