ruff
Installation
Entrypoint
Types
Ruff

ruff

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/softwaredevelop/daggerverse/ruff@fa6c0c101a5138bd7761fe46c64d4a46a3804e07

Entrypoint

Return Type

Ruff

Example

dagger -m github.com/softwaredevelop/daggerverse/ruff@fa6c0c101a5138bd7761fe46c64d4a46a3804e07 call \

func (m *myModule) example() *Ruff  {
	return dag.
			Ruff()
}

@function
def example() -> dag.Ruff:
	return (
		dag.ruff()
	)

@func()
example(): Ruff {
	return dag
		.ruff()
}

Types

Ruff 🔗

containerEcho() 🔗

Returns a container that echoes whatever string argument is provided

Return Type

Container !

Arguments

Name	Type	Default Value	Description
stringArg	String !	-	No description provided

Example

dagger -m github.com/softwaredevelop/daggerverse/ruff@fa6c0c101a5138bd7761fe46c64d4a46a3804e07 call \
 container-echo --string-arg string

func (m *myModule) example(stringArg string) *Container  {
	return dag.
			Ruff().
			ContainerEcho(stringArg)
}

@function
def example(string_arg: str) -> dagger.Container:
	return (
		dag.ruff()
		.container_echo(string_arg)
	)

@func()
example(stringArg: string): Container {
	return dag
		.ruff()
		.containerEcho(stringArg)
}

grepDir() 🔗

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

Return Type

String !

Arguments

Name	Type	Default Value	Description
directoryArg	Directory !	-	No description provided
pattern	String !	-	No description provided

Example

dagger -m github.com/softwaredevelop/daggerverse/ruff@fa6c0c101a5138bd7761fe46c64d4a46a3804e07 call \
 grep-dir --directory-arg DIR_PATH --pattern string

func (m *myModule) example(ctx context.Context, directoryArg *Directory, pattern string) string  {
	return dag.
			Ruff().
			GrepDir(ctx, directoryArg, pattern)
}

@function
async def example(directory_arg: dagger.Directory, pattern: str) -> str:
	return await (
		dag.ruff()
		.grep_dir(directory_arg, pattern)
	)

@func()
async example(directoryArg: Directory, pattern: string): Promise<string> {
	return dag
		.ruff()
		.grepDir(directoryArg, pattern)
}

checkWithConfig() 🔗

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	source is an optional argument that specifies a directory.
file	File !	-	file is an optional argument that specifies ruff configuration file.

Example

dagger -m github.com/softwaredevelop/daggerverse/ruff@fa6c0c101a5138bd7761fe46c64d4a46a3804e07 call \
 check-with-config --source DIR_PATH --file file:path

func (m *myModule) example(source *Directory, file *File) *Container  {
	return dag.
			Ruff().
			CheckWithConfig(source, file)
}

@function
def example(source: dagger.Directory, file: dagger.File) -> dagger.Container:
	return (
		dag.ruff()
		.check_with_config(source, file)
	)

@func()
example(source: Directory, file: File): Container {
	return dag
		.ruff()
		.checkWithConfig(source, file)
}

check() 🔗

Check runs the ruff check command.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	source is an optional argument that specifies a directory.

Example

dagger -m github.com/softwaredevelop/daggerverse/ruff@fa6c0c101a5138bd7761fe46c64d4a46a3804e07 call \
 check --source DIR_PATH

func (m *myModule) example(source *Directory) *Container  {
	return dag.
			Ruff().
			Check(source)
}

@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.ruff()
		.check(source)
	)

@func()
example(source: Directory): Container {
	return dag
		.ruff()
		.check(source)
}