Index (dev.dimlight:shellcheck-maven-plugin 0.5.0 API)

A

Architecture - Enum Class in dev.dimlight.maven.plugin.shellcheck: Light-hearted os/arch detection, just enough to pick up the shellcheck binary.

BinaryResolutionMethod - Enum Class in dev.dimlight.maven.plugin.shellcheck: All the ways the plugin can resolve the shellcheck binary.
BinaryResolver - Class in dev.dimlight.maven.plugin.shellcheck: Groups differents ways of getting hold of the correct shellcheck binary.
BinaryResolver(MavenProject, MavenSession, BuildPluginManager, Path, Optional<Path>, Map<String, URL>, Log) - Constructor for class dev.dimlight.maven.plugin.shellcheck.BinaryResolver

ChunkIterator<T> - Class in dev.dimlight.maven.plugin.shellcheck: A stateful decorator to divide a list in chunks of a (at most) given size.
cmdLine - Variable in class dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result: The actual command line that was ran to execute shellcheck, as a list.

detect() - Static method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: Detects the current architecture on which the plugin is being run.
dev.dimlight.maven.plugin.shellcheck - package dev.dimlight.maven.plugin.shellcheck
download - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.BinaryResolutionMethod: The binary will be downloaded at plugin execution time.
downloadUrl() - Method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture

embedded - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.BinaryResolutionMethod: Use the embedded binary.
embeddedBinPath() - Method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture
execute() - Method in class dev.dimlight.maven.plugin.shellcheck.ShellCheckMojo
execute() - Method in class HelpMojo
exitCode - Variable in class dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result: The os exit code for the shellcheck invocation.
external - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.BinaryResolutionMethod: The path to an externally provided shellcheck binary must be provided.

getPathInPluginOutputDirectory(String...) - Method in class dev.dimlight.maven.plugin.shellcheck.PluginPaths
getPluginOutputDirectory() - Method in class dev.dimlight.maven.plugin.shellcheck.PluginPaths
guessUnpackedBinary(Path, Architecture) - Static method in class dev.dimlight.maven.plugin.shellcheck.BinaryResolver: Walks the files in fromPath to find what is likely the shellcheck binary.

hasNext() - Method in class dev.dimlight.maven.plugin.shellcheck.ChunkIterator
HelpMojo - Class in Unnamed Package: Display help information on shellcheck-maven-plugin.
Call mvn shellcheck:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class HelpMojo

idiomaticExecutableSuffix() - Method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture
isNotOk() - Method in class dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result
isUnixLike() - Method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture

Linux_aarch64 - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: ARM64.
Linux_armv6hf - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: raspberry pi (arm 32).
Linux_x86_64 - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: amd64.

macOS_x86_64 - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: macosx on intel.
makeExecutable(Path) - Method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: Makes the given path executable (for unices, for windows does nothing).

osArchKey() - Static method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: Returns the currently os/arch key identifier.
over(int, Iterable<T>) - Static method in class dev.dimlight.maven.plugin.shellcheck.ChunkIterator

PluginPaths - Class in dev.dimlight.maven.plugin.shellcheck: Utilities for paths related to the plugin.
PluginPaths(Path) - Constructor for class dev.dimlight.maven.plugin.shellcheck.PluginPaths

resolve(BinaryResolutionMethod) - Method in class dev.dimlight.maven.plugin.shellcheck.BinaryResolver: Performs binary resolution.
Result(String, List<String>, int, Path, Path) - Constructor for class dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result
run(String, Path, List<String>, List<Path>, Path, Path) - Static method in class dev.dimlight.maven.plugin.shellcheck.Shellcheck: Runs the provided shellcheck binary capturing its output and return code.
runId - Variable in class dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result: Run id.

Shellcheck - Class in dev.dimlight.maven.plugin.shellcheck: A thin java wrapper over the shellcheck binary for execution.
Shellcheck.Result - Class in dev.dimlight.maven.plugin.shellcheck: The results of a shellcheck run.
ShellCheckMojo - Class in dev.dimlight.maven.plugin.shellcheck: Runs the shellcheck binary on the files specified with sourceDirs.
ShellCheckMojo() - Constructor for class dev.dimlight.maven.plugin.shellcheck.ShellCheckMojo
SourceDir - Class in dev.dimlight.maven.plugin.shellcheck: Configuration item that represents a source dir.
SourceDir() - Constructor for class dev.dimlight.maven.plugin.shellcheck.SourceDir
stderr - Variable in class dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result: Path where the captured stderr has been redirected.
stdout - Variable in class dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result: Path where the captured stdout has been redirected.

unsupported - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: none of the above.

valueOf(String) - Static method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.dimlight.maven.plugin.shellcheck.BinaryResolutionMethod: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.dimlight.maven.plugin.shellcheck.BinaryResolutionMethod: Returns an array containing the constants of this enum class, in the order they are declared.
VERSION - Static variable in class dev.dimlight.maven.plugin.shellcheck.Shellcheck: The version of shellcheck that is embedded in the plugin jar.

Windows_x86 - Enum constant in enum class dev.dimlight.maven.plugin.shellcheck.Architecture: win32.