Dagger
Search

shellcheck

No long description provided.

Installation

dagger install github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f

Entrypoint

Return Type 
Shellcheck
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f 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 🔗

check() 🔗

Report the issues that need to be fix on a given file.

Return Type 
Report !
Arguments
NameTypeDefault ValueDescription
fileFile !-No description provided
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f call \
 check --file file:path
func (m *myModule) example(file *File) *ShellcheckReport  {
	return dag.
			Shellcheck().
			Check(file)
}
@function
def example(file: dagger.File) -> dag.ShellcheckReport:
	return (
		dag.shellcheck()
		.check(file)
	)
@func()
example(file: File): ShellcheckReport {
	return dag
		.shellcheck()
		.check(file)
}

Report 🔗

issues() 🔗

Return Type 
[Issue ! ] !
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f call \
 check --file file:path \
 issues
func (m *myModule) example(file *File) []*ShellcheckIssue  {
	return dag.
			Shellcheck().
			Check(file).
			Issues()
}
@function
def example(file: dagger.File) -> List[dag.ShellcheckIssue]:
	return (
		dag.shellcheck()
		.check(file)
		.issues()
	)
@func()
example(file: File): ShellcheckIssue[] {
	return dag
		.shellcheck()
		.check(file)
		.issues()
}

jSon() 🔗

Return Type 
String !
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f call \
 check --file file:path \
 j-s-o-n
func (m *myModule) example(ctx context.Context, file *File) string  {
	return dag.
			Shellcheck().
			Check(file).
			JSON(ctx)
}
@function
async def example(file: dagger.File) -> str:
	return await (
		dag.shellcheck()
		.check(file)
		.j_s_o_n()
	)
@func()
async example(file: File): Promise<string> {
	return dag
		.shellcheck()
		.check(file)
		.jSON()
}

report() 🔗

Return Type 
String !
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f call \
 check --file file:path \
 report
func (m *myModule) example(ctx context.Context, file *File) string  {
	return dag.
			Shellcheck().
			Check(file).
			Report(ctx)
}
@function
async def example(file: dagger.File) -> str:
	return await (
		dag.shellcheck()
		.check(file)
		.report()
	)
@func()
async example(file: File): Promise<string> {
	return dag
		.shellcheck()
		.check(file)
		.report()
}

fixedDiff() 🔗

Return Type 
String !
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f call \
 check --file file:path \
 fixed-diff
func (m *myModule) example(ctx context.Context, file *File) string  {
	return dag.
			Shellcheck().
			Check(file).
			FixedDiff(ctx)
}
@function
async def example(file: dagger.File) -> str:
	return await (
		dag.shellcheck()
		.check(file)
		.fixed_diff()
	)
@func()
async example(file: File): Promise<string> {
	return dag
		.shellcheck()
		.check(file)
		.fixedDiff()
}

assert() 🔗

Return Type 
Void !
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f call \
 check --file file:path \
 assert
func (m *myModule) example(ctx context.Context, file *File)   {
	return dag.
			Shellcheck().
			Check(file).
			Assert(ctx)
}
@function
async def example(file: dagger.File) -> None:
	return await (
		dag.shellcheck()
		.check(file)
		.assert_()
	)
@func()
async example(file: File): Promise<void> {
	return dag
		.shellcheck()
		.check(file)
		.assert()
}

fixed() 🔗

Return Type 
File !
Example
dagger -m github.com/shykes/dagger/modules/shellcheck@a5ea6e6a94d2afc84b695c6ca75fc8c6f3ae748f call \
 check --file file:path \
 fixed
func (m *myModule) example(file *File) *File  {
	return dag.
			Shellcheck().
			Check(file).
			Fixed()
}
@function
def example(file: dagger.File) -> dagger.File:
	return (
		dag.shellcheck()
		.check(file)
		.fixed()
	)
@func()
example(file: File): File {
	return dag
		.shellcheck()
		.check(file)
		.fixed()
}

Issue 🔗

filename() 🔗

Return Type 
String !
Example
Function ShellcheckIssue.filename is not accessible from the shellcheck module
Function ShellcheckIssue.filename is not accessible from the shellcheck module
Function ShellcheckIssue.filename is not accessible from the shellcheck module
Function ShellcheckIssue.filename is not accessible from the shellcheck module

line() 🔗

Return Type 
Integer !
Example
Function ShellcheckIssue.line is not accessible from the shellcheck module
Function ShellcheckIssue.line is not accessible from the shellcheck module
Function ShellcheckIssue.line is not accessible from the shellcheck module
Function ShellcheckIssue.line is not accessible from the shellcheck module

lineEnd() 🔗

Return Type 
Integer !
Example
Function ShellcheckIssue.lineEnd is not accessible from the shellcheck module
Function ShellcheckIssue.lineEnd is not accessible from the shellcheck module
Function ShellcheckIssue.lineEnd is not accessible from the shellcheck module
Function ShellcheckIssue.lineEnd is not accessible from the shellcheck module

column() 🔗

Return Type 
Integer !
Example
Function ShellcheckIssue.column is not accessible from the shellcheck module
Function ShellcheckIssue.column is not accessible from the shellcheck module
Function ShellcheckIssue.column is not accessible from the shellcheck module
Function ShellcheckIssue.column is not accessible from the shellcheck module

columnEnd() 🔗

Return Type 
Integer !
Example
Function ShellcheckIssue.columnEnd is not accessible from the shellcheck module
Function ShellcheckIssue.columnEnd is not accessible from the shellcheck module
Function ShellcheckIssue.columnEnd is not accessible from the shellcheck module
Function ShellcheckIssue.columnEnd is not accessible from the shellcheck module

level() 🔗

Return Type 
String !
Example
Function ShellcheckIssue.level is not accessible from the shellcheck module
Function ShellcheckIssue.level is not accessible from the shellcheck module
Function ShellcheckIssue.level is not accessible from the shellcheck module
Function ShellcheckIssue.level is not accessible from the shellcheck module

code() 🔗

Return Type 
Integer !
Example
Function ShellcheckIssue.code is not accessible from the shellcheck module
Function ShellcheckIssue.code is not accessible from the shellcheck module
Function ShellcheckIssue.code is not accessible from the shellcheck module
Function ShellcheckIssue.code is not accessible from the shellcheck module

message() 🔗

Return Type 
String !
Example
Function ShellcheckIssue.message is not accessible from the shellcheck module
Function ShellcheckIssue.message is not accessible from the shellcheck module
Function ShellcheckIssue.message is not accessible from the shellcheck module
Function ShellcheckIssue.message is not accessible from the shellcheck module