zuke.tools.shellcheck
@zuke/shellcheck 1.1.0: @zuke/shellcheck — typed [ShellCheck](https://www.shellcheck.net/) task wrappers for Zuke builds.
zuke on PyPI ↗ 2 symbols
Symbols
class ShellcheckSettings(ToolSettings) Settings for a shellcheck run.
-
paths(*values: str) -> SelfScripts to check (positional); repeatable.
-
shell(dialect: Literal['sh', 'bash', 'dash', 'ksh', 'busybox']) -> SelfThe dialect to analyse as (
-s/--shell), overriding the shebang. This is the flag that makes a portability gate mean something: a script with a#!/bin/bashshebang, or none at all, is otherwise checked as bash, so the POSIX violations the gate exists to catch go unreported. -
severity(level: Literal['error', 'warning', 'info', 'style']) -> SelfThe lowest severity to report (
-S/--severity). -
format(value: Literal['tty', 'gcc', 'checkstyle', 'diff', 'json', 'json1', 'quiet']) -> SelfThe output format (
-f/--format). -
exclude(*codes: str) -> SelfSuppress specific checks by code (
-e/--exclude); repeatable. Codes may be given with or without theSCprefix, as ShellCheck accepts both. -
external_sources() -> SelfFollow
sourced files outside the checked set (-x/--external-sources).
class ShellcheckTasks Typed task functions for the ShellCheck static analyser.
-
static async lint(ctx: ServiceContext, configure: Callable[[ShellcheckSettings], ShellcheckSettings] | None=None) -> ExecResultAnalyse shell scripts with
shellcheck.