Dagger
Search

ps-analyzer

No long description provided.

Installation

dagger install github.com/dagger/PsScriptAnalyzer@d87a12883dccd495bee98da9d2c20eb44b6f608d

Entrypoint

Return Type 
PsAnalyzer !
Arguments
NameTypeDefault ValueDescription
versionString -PSScriptAnalyzer version to install
exclude[String ! ] -PowerShell script paths to exclude from checking
includeExtraFiles[String ! ] -Extra non-PowerShell file paths to include for scripts that need project context
Example
dagger -m github.com/dagger/PsScriptAnalyzer@d87a12883dccd495bee98da9d2c20eb44b6f608d call \

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

Types

PsAnalyzer 🔗

A linter for PowerShell scripts, powered by PSScriptAnalyzer

version() 🔗

PSScriptAnalyzer version to install

Return Type 
String !
Example
dagger -m github.com/dagger/PsScriptAnalyzer@d87a12883dccd495bee98da9d2c20eb44b6f608d call \
 version
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			PsAnalyzer().
			Version(ctx)
}
@function
async def example() -> str:
	return await (
		dag.ps_analyzer()
		.version()
	)
@func()
async example(): Promise<string> {
	return dag
		.psAnalyzer()
		.version()
}

exclude() 🔗

PowerShell script paths to exclude from checking

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

includeExtraFiles() 🔗

Extra non-PowerShell file paths to include for scripts that need project context

Return Type 
[String ! ] !
Example
dagger -m github.com/dagger/PsScriptAnalyzer@d87a12883dccd495bee98da9d2c20eb44b6f608d call \
 include-extra-files
func (m *MyModule) Example(ctx context.Context) []string  {
	return dag.
			PsAnalyzer().
			IncludeExtraFiles(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.ps_analyzer()
		.include_extra_files()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.psAnalyzer()
		.includeExtraFiles()
}

check() 🔗

Run PSScriptAnalyzer on all PowerShell 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.
			PsAnalyzer().
			Check(ctx)
}
@function
async def example() -> None:
	return await (
		dag.ps_analyzer()
		.check()
	)
@func()
async example(): Promise<void> {
	return dag
		.psAnalyzer()
		.check()
}

base() 🔗

The base container with PSScriptAnalyzer installed

Return Type 
Container !
Example
dagger -m github.com/dagger/PsScriptAnalyzer@d87a12883dccd495bee98da9d2c20eb44b6f608d call \
 base
func (m *MyModule) Example() *dagger.Container  {
	return dag.
			PsAnalyzer().
			Base()
}
@function
def example() -> dagger.Container:
	return (
		dag.ps_analyzer()
		.base()
	)
@func()
example(): Container {
	return dag
		.psAnalyzer()
		.base()
}