Dagger
Search

shellcheck

No long description provided.

Installation

dagger install github.com/dagger/shellcheck@34bcb268f4483fa31ea9e33b6a86aa7892144323

Entrypoint

Return Type 
Shellcheck !
Arguments
NameTypeDefault ValueDescription
exclude[String ! ] -Shell script paths to exclude from checking
Example
dagger -m github.com/dagger/shellcheck@34bcb268f4483fa31ea9e33b6a86aa7892144323 call \

func (m *MyModule) Example() *dagger.Shellcheck  {
	return dag.
			Shellcheck()
}
@function
def example() -> dagger.Shellcheck:
	return (
		dag.shellcheck()
	)
@func()
example(): Shellcheck {
	return dag
		.shellcheck()
}

Entrypoint

Return Type 
Script !
Arguments
NameTypeDefault ValueDescription
fileFile !-The shell script file to check
pathString !-The path of the script relative to the workspace root
baseContainer !-The base container used to run shellcheck
Example
Function Script.Constructor is not accessible from the shellcheck module
Function Script.Constructor is not accessible from the shellcheck module
Function Script.Constructor is not accessible from the shellcheck module
Function Script.Constructor is not accessible from the shellcheck module

Types

Shellcheck 🔗

A linter for shell scripts, powered by shellcheck

exclude() 🔗

Shell script paths to exclude from checking

Return Type 
[String ! ]
Example
dagger -m github.com/dagger/shellcheck@34bcb268f4483fa31ea9e33b6a86aa7892144323 call \
 exclude
func (m *MyModule) Example(ctx context.Context) []string  {
	return dag.
			Shellcheck().
			Exclude(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.shellcheck()
		.exclude()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.shellcheck()
		.exclude()
}

check() 🔗

Run shellcheck on all shell scripts in the workspace

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			Shellcheck().
			Check(ctx)
}
@function
async def example() -> None:
	return await (
		dag.shellcheck()
		.check()
	)
@func()
async example(): Promise<void> {
	return dag
		.shellcheck()
		.check()
}

scripts() 🔗

Find all .sh files in the workspace and return them as Script objects

Return Type 
[Script ! ] !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example() []*dagger.ShellcheckScript  {
	return dag.
			Shellcheck().
			Scripts()
}
@function
def example() -> List[dagger.ShellcheckScript]:
	return (
		dag.shellcheck()
		.scripts()
	)
@func()
example(): ShellcheckScript[] {
	return dag
		.shellcheck()
		.scripts()
}

base() 🔗

The base container with shellcheck installed

Return Type 
Container !
Example
dagger -m github.com/dagger/shellcheck@34bcb268f4483fa31ea9e33b6a86aa7892144323 call \
 base
func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Shellcheck().
			Base()
}
@function
def example() -> dagger.Container:
	return (
		dag.shellcheck()
		.base()
	)
@func()
example(): Container {
	return dag
		.shellcheck()
		.base()
}

Script 🔗

path() 🔗

The path of the script relative to the workspace root

Return Type 
String !
Example
Function ShellcheckScript.path is not accessible from the shellcheck module
Function ShellcheckScript.path is not accessible from the shellcheck module
Function ShellcheckScript.path is not accessible from the shellcheck module
Function ShellcheckScript.path is not accessible from the shellcheck module

check() 🔗

Run shellcheck on this script

Return Type 
Void !
Example
Function ShellcheckScript.check is not accessible from the shellcheck module
Function ShellcheckScript.check is not accessible from the shellcheck module
Function ShellcheckScript.check is not accessible from the shellcheck module
Function ShellcheckScript.check is not accessible from the shellcheck module