ruff
Installation
Entrypoint
Types
Checker
Formatter
Ruff

ruff

No long description provided.

Installation

dagger install github.com/typesafe-ai/daggerverse/ruff@0aff9abc859913ec9119017b52550c5d42ad715e

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@0aff9abc859913ec9119017b52550c5d42ad715e 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@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

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@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

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@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

Formatter 🔗

Ruff formatter (``ruff format``).

ctr() 🔗

Container with ruff installed.

Return Type

Container !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

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@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

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@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

Ruff 🔗

Ruff Python linter and formatter.

ctr() 🔗

Container with ruff installed.

Return Type

Container !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

check() 🔗

Return the ruff linter (ruff check).

Return Type

Checker !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@0aff9abc859913ec9119017b52550c5d42ad715e 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@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}

version() 🔗

The resolved ruff version.

Return Type

String !

Example

dagger -m github.com/typesafe-ai/daggerverse/ruff@0aff9abc859913ec9119017b52550c5d42ad715e 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()
}