shellcheck
This module has been generated via dagger init and serves as a reference tobasic module structure as you get started with Dagger.
Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.
The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.
Installation
dagger install github.com/softwaredevelop/daggerverse/shellcheck@4592841182b2c44b1d0d563fb463b69255cbfbf8
Entrypoint
Return Type
Shellcheck !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
image | String | - | Custom image reference in "repository:tag" format to use as a base container. |
Example
dagger -m github.com/softwaredevelop/daggerverse/shellcheck@4592841182b2c44b1d0d563fb463b69255cbfbf8 call \
func (m *myModule) example() *Shellcheck {
return dag.
Shellcheck()
}
@function
def example() -> dag.Shellcheck:
return (
dag.shellcheck()
)
@func()
example(): Shellcheck {
return dag
.shellcheck()
}
Types
Shellcheck 🔗
Shellcheck is a module for checking shell scripts.
container() 🔗
Container returns the underlying Dagger container
Return Type
Container !
Example
dagger -m github.com/softwaredevelop/daggerverse/shellcheck@4592841182b2c44b1d0d563fb463b69255cbfbf8 call \
container
func (m *myModule) example() *Container {
return dag.
Shellcheck().
Container()
}
@function
def example() -> dagger.Container:
return (
dag.shellcheck()
.container()
)
@func()
example(): Container {
return dag
.shellcheck()
.container()
}
check() 🔗
Check runs the shellcheck command.
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | source is an optional argument that specifies a directory. |
Example
dagger -m github.com/softwaredevelop/daggerverse/shellcheck@4592841182b2c44b1d0d563fb463b69255cbfbf8 call \
check --source DIR_PATH
func (m *myModule) example(source *Directory) *Container {
return dag.
Shellcheck().
Check(source)
}
@function
def example(source: dagger.Directory) -> dagger.Container:
return (
dag.shellcheck()
.check(source)
)
@func()
example(source: Directory): Container {
return dag
.shellcheck()
.check(source)
}