A collection of +180 reusable WebAssembly modules for building composable CI/CD pipelines with FluentCI fluentci.io/modules
modules linting shellcheck COMPONENT.md
3.2 kB · 53 lines
Markdown
at main

shellcheck component functions #

Requires FluentCI v0.17.3 or newer. The compiler derives native WIT signatures and embedded help from these typed PureScript functions. Optional arguments may be omitted.

run #

Execute arbitrary literal CLI arguments.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
arguments array yes Literal native CLI argument tokens, passed without shell expansion.

Returns Contract.ExecutionResult.

version #

Print the CLI version.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.

Returns Contract.ExecutionResult.

lint #

Check explicit shell scripts.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
shell string no Shell supplied to the shellcheck lint operation. Allowed values: sh, bash, dash, ksh.
severity string no Severity supplied to the shellcheck lint operation. Allowed values: error, warning, info, style.
exclude string no Exclude supplied to the shellcheck lint operation.
format string no Format supplied to the shellcheck lint operation.
external-sources boolean no External Sources supplied to the shellcheck lint operation.
files array yes Files selected for the native operation; paths are passed literally without shell expansion.

Returns Contract.ExecutionResult.