ShellCheck Package

The ModularPipelines.Shellcheck package provides strongly typed access to the ShellCheck static analysis CLI.

Installation

dotnet add package ModularPipelines.Shellcheck

Install the package and invoke ShellCheck through the pipeline context:

using ModularPipelines.Shellcheck.Enums;
using ModularPipelines.Shellcheck.Extensions;
using ModularPipelines.Shellcheck.Options;

public class CheckShellScriptsModule : Module<CommandResult>
{
    protected override async Task<CommandResult?> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Shellcheck().Execute(
            new ShellcheckExecuteOptions
            {
                Files = ["scripts/build.sh", "scripts/deploy.sh"],
                CheckSourced = true,
                Format = ShellcheckFormat.Gcc,
                Severity = ShellcheckSeverity.Warning,
                Shell = ShellcheckShell.Bash,
            },
            cancellationToken: cancellationToken);
    }
}

Input files are optional so standalone actions such as --version remain available; pass files through Files when analyzing scripts. Options with fixed value sets use enums, --extended-analysis uses a boolean, and --wiki-link-count uses an integer. ShellCheck must be installed and available on PATH when the pipeline runs.