ps-analyzer
The PowerShell Script Analyzer (PSScriptAnalyzer) for Dagger.
Installation
dagger install github.com/dagger/dagger/modules/ps-analyzer@v0.13.3
Entrypoint
Return Type
PsAnalyzer
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
func (m *myModule) example() *PsAnalyzer {
return dag.
PsAnalyzer()
}
@function
def example() -> dag.PsAnalyzer:
return (
dag.ps_analyzer()
)
@func()
example(): PsAnalyzer {
return dag
.psAnalyzer()
}
Types
PsAnalyzer 🔗
check() 🔗
Return Type
PsAnalyzerReport !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
file | File ! | - | The file that want to check. |
excludeRules | [String ! ] | - | Exclude rules out of the analyzer. |
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
check --file file:path
func (m *myModule) example(file *File) *PsAnalyzerReport {
return dag.
PsAnalyzer().
Check(file)
}
@function
def example(file: dagger.File) -> dag.PsAnalyzerReport:
return (
dag.ps_analyzer()
.check(file)
)
@func()
example(file: File): PsAnalyzerReport {
return dag
.psAnalyzer()
.check(file)
}
base() 🔗
Return Type
Container !
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
base
func (m *myModule) example() *Container {
return dag.
PsAnalyzer().
Base()
}
@function
def example() -> dagger.Container:
return (
dag.ps_analyzer()
.base()
)
@func()
example(): Container {
return dag
.psAnalyzer()
.base()
}
PsAnalyzerReport 🔗
issues() 🔗
Return Type
[PsAnalyzerIssue ! ] !
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
check --file file:path \
issues
func (m *myModule) example(file *File) []*PsAnalyzerIssue {
return dag.
PsAnalyzer().
Check(file).
Issues()
}
@function
def example(file: dagger.File) -> List[dag.PsAnalyzerIssue]:
return (
dag.ps_analyzer()
.check(file)
.issues()
)
@func()
example(file: File): PsAnalyzerIssue[] {
return dag
.psAnalyzer()
.check(file)
.issues()
}
jSon() 🔗
Return Type
String !
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
check --file file:path \
j-s-o-n
func (m *myModule) example(ctx context.Context, file *File) string {
return dag.
PsAnalyzer().
Check(file).
JSON(ctx)
}
@function
async def example(file: dagger.File) -> str:
return await (
dag.ps_analyzer()
.check(file)
.j_s_o_n()
)
@func()
async example(file: File): Promise<string> {
return dag
.psAnalyzer()
.check(file)
.jSON()
}
report() 🔗
Return Type
String !
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
check --file file:path \
report
func (m *myModule) example(ctx context.Context, file *File) string {
return dag.
PsAnalyzer().
Check(file).
Report(ctx)
}
@function
async def example(file: dagger.File) -> str:
return await (
dag.ps_analyzer()
.check(file)
.report()
)
@func()
async example(file: File): Promise<string> {
return dag
.psAnalyzer()
.check(file)
.report()
}
fixedDiff() 🔗
Return Type
String !
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
check --file file:path \
fixed-diff
func (m *myModule) example(ctx context.Context, file *File) string {
return dag.
PsAnalyzer().
Check(file).
FixedDiff(ctx)
}
@function
async def example(file: dagger.File) -> str:
return await (
dag.ps_analyzer()
.check(file)
.fixed_diff()
)
@func()
async example(file: File): Promise<string> {
return dag
.psAnalyzer()
.check(file)
.fixedDiff()
}
assert() 🔗
Return Type
Void !
Example
dagger -m github.com/dagger/dagger/modules/ps-analyzer@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
check --file file:path \
assert
func (m *myModule) example(ctx context.Context, file *File) {
return dag.
PsAnalyzer().
Check(file).
Assert(ctx)
}
@function
async def example(file: dagger.File) -> None:
return await (
dag.ps_analyzer()
.check(file)
.assert_()
)
@func()
async example(file: File): Promise<void> {
return dag
.psAnalyzer()
.check(file)
.assert()
}
PsAnalyzerIssue 🔗
filename() 🔗
Return Type
String !
Example
Function PsAnalyzerIssue.filename is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.filename is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.filename is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.filename is not accessible from the ps-analyzer module
line() 🔗
Return Type
Integer !
Example
Function PsAnalyzerIssue.line is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.line is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.line is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.line is not accessible from the ps-analyzer module
lineEnd() 🔗
Return Type
Integer !
Example
Function PsAnalyzerIssue.lineEnd is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.lineEnd is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.lineEnd is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.lineEnd is not accessible from the ps-analyzer module
column() 🔗
Return Type
Integer !
Example
Function PsAnalyzerIssue.column is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.column is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.column is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.column is not accessible from the ps-analyzer module
columnEnd() 🔗
Return Type
Integer !
Example
Function PsAnalyzerIssue.columnEnd is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.columnEnd is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.columnEnd is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.columnEnd is not accessible from the ps-analyzer module
level() 🔗
Return Type
String !
Example
Function PsAnalyzerIssue.level is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.level is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.level is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.level is not accessible from the ps-analyzer module
code() 🔗
Return Type
Integer !
Example
Function PsAnalyzerIssue.code is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.code is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.code is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.code is not accessible from the ps-analyzer module
message() 🔗
Return Type
String !
Example
Function PsAnalyzerIssue.message is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.message is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.message is not accessible from the ps-analyzer module
Function PsAnalyzerIssue.message is not accessible from the ps-analyzer module