shellcheck
No long description provided.
Installation
dagger install github.com/shykes/dagger/modules/shellcheck@a6497f9a06ba47a94e68275c834c522747d3018f
Entrypoint
Return Type
Shellcheck
Example
func (m *myModule) example() *Shellcheck {
return dag.
Shellcheck()
}
Types
Shellcheck 🔗
check() 🔗
Report the issues that need to be fix on a given file.
Return Type
Report !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
file | File ! | - | No description provided |
Example
func (m *myModule) example(file *File) *ShellcheckReport {
return dag.
Shellcheck().
Check(file)
}
Report 🔗
issues() 🔗
Return Type
[Issue ! ] !
Example
func (m *myModule) example(file *File) []*ShellcheckIssue {
return dag.
Shellcheck().
Check(file).
Issues()
}
jSon() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, file *File) string {
return dag.
Shellcheck().
Check(file).
JSON(ctx)
}
report() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, file *File) string {
return dag.
Shellcheck().
Check(file).
Report(ctx)
}
fixedDiff() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, file *File) string {
return dag.
Shellcheck().
Check(file).
FixedDiff(ctx)
}
assert() 🔗
Return Type
Void !
Example
func (m *myModule) example(ctx context.Context, file *File) {
return dag.
Shellcheck().
Check(file).
Assert(ctx)
}
fixed() 🔗
Return Type
File !
Example
func (m *myModule) 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
line() 🔗
Return Type
Integer !
Example
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
column() 🔗
Return Type
Integer !
Example
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
level() 🔗
Return Type
String !
Example
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
message() 🔗
Return Type
String !
Example
Function ShellcheckIssue.message is not accessible from the shellcheck module