ruff
Installation
Entrypoint
Entrypoint
Entrypoint
Types
Checker
Formatter
Ruff

ruff

No long description provided.

Installation

dagger install github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546

Entrypoint

Return Type

Checker !

Arguments

Name	Type	Default Value	Description
ctr	Container !	-	Container with ruff installed.

Example

Function Checker.Constructor is not accessible from the ruff module

Function Checker.Constructor is not accessible from the ruff module

Function Checker.Constructor is not accessible from the ruff module

Function Checker.Constructor is not accessible from the ruff module

Entrypoint

Return Type

Formatter !

Arguments

Name	Type	Default Value	Description
ctr	Container !	-	Container with ruff installed.

Example

Function Formatter.Constructor is not accessible from the ruff module

Function Formatter.Constructor is not accessible from the ruff module

Function Formatter.Constructor is not accessible from the ruff module

Function Formatter.Constructor is not accessible from the ruff module

Entrypoint

Return Type

Ruff !

Arguments

Name	Type	Default Value	Description
source	Directory	null	Project source directory used to auto-detect the ruff version from uv.lock, ruff.toml, .ruff.toml, or pyproject.toml.
ctr	Container	null	Container with ruff installed. Defaults to the official ghcr.io/astral-sh/ruff image.
version	String	null	Ruff image tag. Only used when ``ctr`` is not provided. Overrides auto-detection from source.

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 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

Checker 🔗

Ruff linter (``ruff check``).

ctr() 🔗

Container with ruff installed.

Return Type

Container !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 check \
 ctr

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Ruff().
			Check().
			Ctr()
}

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

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

lint() 🔗

Run ruff check and report violations.

Exits non-zero when violations are found.

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Project source directory.
extraArgs	[String ! ]	null	Additional arguments to pass to ``ruff check``.

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 check \
 lint

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Ruff().
			Check().
			Lint(ctx)
}

@function
async def example() -> str:
	return await (
		dag.ruff()
		.check()
		.lint()
	)

@func()
async example(): Promise<string> {
	return dag
		.ruff()
		.check()
		.lint()
}

fix() 🔗

Auto-fix lint violations and return a Changeset.

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Project source directory.
extraArgs	[String ! ]	null	Additional arguments to pass to ``ruff check --fix``.

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 check \
 fix

func (m *MyModule) Example() *dagger.Changeset  {
	return dag.
			Ruff().
			Check().
			Fix()
}

@function
def example() -> dagger.Changeset:
	return (
		dag.ruff()
		.check()
		.fix()
	)

@func()
example(): Changeset {
	return dag
		.ruff()
		.check()
		.fix()
}

Formatter 🔗

Ruff formatter (``ruff format``).

ctr() 🔗

Container with ruff installed.

Return Type

Container !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 format \
 ctr

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Ruff().
			Format().
			Ctr()
}

@function
def example() -> dagger.Container:
	return (
		dag.ruff()
		.format()
		.ctr()
	)

@func()
example(): Container {
	return dag
		.ruff()
		.format()
		.ctr()
}

lint() 🔗

Run ruff format --check and report unformatted files.

Exits non-zero when files would be reformatted.

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Project source directory.
extraArgs	[String ! ]	null	Additional arguments to pass to ``ruff format --check``.

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 format \
 lint

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Ruff().
			Format().
			Lint(ctx)
}

@function
async def example() -> str:
	return await (
		dag.ruff()
		.format()
		.lint()
	)

@func()
async example(): Promise<string> {
	return dag
		.ruff()
		.format()
		.lint()
}

fix() 🔗

Auto-format source files and return a Changeset.

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Project source directory.
extraArgs	[String ! ]	null	Additional arguments to pass to ``ruff format``.

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 format \
 fix

func (m *MyModule) Example() *dagger.Changeset  {
	return dag.
			Ruff().
			Format().
			Fix()
}

@function
def example() -> dagger.Changeset:
	return (
		dag.ruff()
		.format()
		.fix()
	)

@func()
example(): Changeset {
	return dag
		.ruff()
		.format()
		.fix()
}

Ruff 🔗

Ruff Python linter and formatter.

ctr() 🔗

Container with ruff installed.

Return Type

Container !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 ctr

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Ruff().
			Ctr()
}

@function
def example() -> dagger.Container:
	return (
		dag.ruff()
		.ctr()
	)

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

version() 🔗

The resolved ruff version.

Return Type

String !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 version

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Ruff().
			Version(ctx)
}

@function
async def example() -> str:
	return await (
		dag.ruff()
		.version()
	)

@func()
async example(): Promise<string> {
	return dag
		.ruff()
		.version()
}

check() 🔗

Return the ruff linter (ruff check).

Return Type

Checker !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 check

func (m *MyModule) Example() *dagger.RuffChecker  {
	return dag.
			Ruff().
			Check()
}

@function
def example() -> dagger.RuffChecker:
	return (
		dag.ruff()
		.check()
	)

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

format() 🔗

Return the ruff formatter (ruff format).

Return Type

Formatter !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@3332f581cb4b157783ee40be868d2f3e85d42546 call \
 format

func (m *MyModule) Example() *dagger.RuffFormatter  {
	return dag.
			Ruff().
			Format()
}

@function
def example() -> dagger.RuffFormatter:
	return (
		dag.ruff()
		.format()
	)

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