Dagger
Search

snyk-dagger

This module has been generated via dagger init and serves as a reference to basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them, as needed. They demonstrate usage of arguments and return types using simple echo and grep commands. The functions can be called from the dagger CLI or from one of the SDKs.

The first line in this comment block is a short description line and the rest is a long description with more detail on the module's purpose or usage, if appropriate. All modules should have a short description.

Installation

dagger install github.com/z4ce/snyk-dagger@b36086a11a617cb5a34d521bbe0aff4e1a1581d0

Entrypoint

Return Type 
SnykDagger
Example
func (m *myModule) example() *SnykDagger  {
	return dag.
			SnykDagger()
}
@function
def example() -> dag.SnykDagger:
	return (
		dag.snyk_dagger()
	)
@func()
example(): SnykDagger {
	return dag
		.snykDagger()
}

Types

SnykDagger

containerEcho()

Returns a container that echoes whatever string argument is provided

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
stringArgString !-No description provided
Example
dagger -m github.com/z4ce/snyk-dagger@b36086a11a617cb5a34d521bbe0aff4e1a1581d0 call \
 container-echo --string-arg string
func (m *myModule) example(stringArg string) *Container  {
	return dag.
			SnykDagger().
			ContainerEcho(stringArg)
}
@function
def example(string_arg: str) -> dagger.Container:
	return (
		dag.snyk_dagger()
		.container_echo(string_arg)
	)
@func()
example(stringArg: string): Container {
	return dag
		.snykDagger()
		.containerEcho(stringArg)
}

grepDir()

Returns lines that match a pattern in the files of the provided Directory

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
directoryArgDirectory !-No description provided
patternString !-No description provided
Example
dagger -m github.com/z4ce/snyk-dagger@b36086a11a617cb5a34d521bbe0aff4e1a1581d0 call \
 grep-dir --directory-arg DIR_PATH --pattern string
func (m *myModule) example(ctx context.Context, directoryArg *Directory, pattern string) string  {
	return dag.
			SnykDagger().
			GrepDir(ctx, directoryArg, pattern)
}
@function
async def example(directory_arg: dagger.Directory, pattern: str) -> str:
	return await (
		dag.snyk_dagger()
		.grep_dir(directory_arg, pattern)
	)
@func()
async example(directoryArg: Directory, pattern: string): Promise<string> {
	return dag
		.snykDagger()
		.grepDir(directoryArg, pattern)
}

snykCodeTest()

Returns lines that match a pattern in the files of the provided Directory

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
tokenString !-No description provided
variantString !-No description provided
directoryDirectory !-No description provided
extraArgs[String ! ] []No description provided
Example
dagger -m github.com/z4ce/snyk-dagger@b36086a11a617cb5a34d521bbe0aff4e1a1581d0 call \
 snyk-code-test --token string --variant string --directory DIR_PATH
func (m *myModule) example(ctx context.Context, token string, variant string, directory *Directory) string  {
	return dag.
			SnykDagger().
			SnykCodeTest(ctx, token, variant, directory)
}
@function
async def example(token: str, variant: str, directory: dagger.Directory) -> str:
	return await (
		dag.snyk_dagger()
		.snyk_code_test(token, variant, directory)
	)
@func()
async example(token: string, variant: string, directory: Directory): Promise<string> {
	return dag
		.snykDagger()
		.snykCodeTest(token, variant, directory)
}