Dagger
Search

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@793c6b5d581e771c418e8e6c778554185c6c730c

Entrypoint

Return Type 
Ruff
Example
dagger -m github.com/softwaredevelop/daggerverse/ruff@793c6b5d581e771c418e8e6c778554185c6c730c call \

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

Types

Ruff 🔗

check() 🔗

Check runs the ruff check command.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-source is an optional argument that specifies a directory.
Example
dagger -m github.com/softwaredevelop/daggerverse/ruff@793c6b5d581e771c418e8e6c778554185c6c730c call \
 check --source DIR_PATH
func (m *MyModule) Example(source *dagger.Directory) *dagger.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)
}

checkWithConfig() 🔗

CheckWithConfig runs the ruff check command with a configuration file.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-source is an optional argument that specifies a directory.
fileFile !-file is an optional argument that specifies ruff configuration file.
Example
dagger -m github.com/softwaredevelop/daggerverse/ruff@793c6b5d581e771c418e8e6c778554185c6c730c call \
 check-with-config --source DIR_PATH --file file:path
func (m *MyModule) Example(source *dagger.Directory, file *dagger.File) *dagger.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)
}