Dagger
Search

ruff

No long description provided.

Installation

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

Entrypoint

Return Type
Checker !
Arguments
NameTypeDefault ValueDescription
ctrContainer !-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
NameTypeDefault ValueDescription
ctrContainer !-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
NameTypeDefault ValueDescription
sourceDirectory nullProject source directory used to auto-detect the ruff version from uv.lock, ruff.toml, .ruff.toml, or pyproject.toml.
ctrContainer nullContainer with ruff installed. Defaults to the official ghcr.io/astral-sh/ruff image.
versionString nullRuff image tag. Only used when ``ctr`` is not provided. Overrides auto-detection from source.
Example
dagger -m github.com/typesafe-ai/daggerverse/ruff@0d00a01811dc1590ae335e2c42bef2c48d96474b 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@0d00a01811dc1590ae335e2c42bef2c48d96474b 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
NameTypeDefault ValueDescription
sourceDirectory -Project source directory.
extraArgs[String ! ] nullAdditional arguments to pass to ``ruff check``.
Example
dagger -m github.com/typesafe-ai/daggerverse/ruff@0d00a01811dc1590ae335e2c42bef2c48d96474b 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
NameTypeDefault ValueDescription
sourceDirectory -Project source directory.
extraArgs[String ! ] nullAdditional arguments to pass to ``ruff check --fix``.
Example
dagger -m github.com/typesafe-ai/daggerverse/ruff@0d00a01811dc1590ae335e2c42bef2c48d96474b 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@0d00a01811dc1590ae335e2c42bef2c48d96474b 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
NameTypeDefault ValueDescription
sourceDirectory -Project source directory.
extraArgs[String ! ] nullAdditional arguments to pass to ``ruff format --check``.
Example
dagger -m github.com/typesafe-ai/daggerverse/ruff@0d00a01811dc1590ae335e2c42bef2c48d96474b 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
NameTypeDefault ValueDescription
sourceDirectory -Project source directory.
extraArgs[String ! ] nullAdditional arguments to pass to ``ruff format``.
Example
dagger -m github.com/typesafe-ai/daggerverse/ruff@0d00a01811dc1590ae335e2c42bef2c48d96474b 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@0d00a01811dc1590ae335e2c42bef2c48d96474b 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@0d00a01811dc1590ae335e2c42bef2c48d96474b 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@0d00a01811dc1590ae335e2c42bef2c48d96474b 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@0d00a01811dc1590ae335e2c42bef2c48d96474b 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()
}