pre-commit
Installation
Entrypoint
Types
PreCommit

pre-commit

No long description provided.

Installation

dagger install github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d

Entrypoint

Return Type

PreCommit !

Arguments

Name	Type	Default Value	Description
preCommitVersion	String !	"3.6.2"	No description provided

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string

func (m *MyModule) Example(preCommitVersion string) *dagger.PreCommit  {
	return dag.
			PreCommit(preCommitVersion)
}

@function
def example(pre_commit_version: str) -> dagger.PreCommit:
	return (
		dag.pre_commit(pre_commit_version)
	)

@func()
example(preCommitVersion: string): PreCommit {
	return dag
		.preCommit(preCommitVersion)
}

Types

PreCommit 🔗

container() 🔗

Return Type

Container !

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string container

func (m *MyModule) Example(preCommitVersion string) *dagger.Container  {
	return dag.
			PreCommit(preCommitVersion).
			Container()
}

@function
def example(pre_commit_version: str) -> dagger.Container:
	return (
		dag.pre_commit(pre_commit_version)
		.container()
	)

@func()
example(preCommitVersion: string): Container {
	return dag
		.preCommit(preCommitVersion)
		.container()
}

withContainer() 🔗

Return Type

PreCommit !

Arguments

Name	Type	Default Value	Description
ctr	Container !	-	An OCI-compatible container, also known as a Docker container.

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string with-container --ctr IMAGE:TAG

func (m *MyModule) Example(preCommitVersion string, ctr *dagger.Container) *dagger.PreCommit  {
	return dag.
			PreCommit(preCommitVersion).
			WithContainer(ctr)
}

@function
def example(pre_commit_version: str, ctr: dagger.Container) -> dagger.PreCommit:
	return (
		dag.pre_commit(pre_commit_version)
		.with_container(ctr)
	)

@func()
example(preCommitVersion: string, ctr: Container): PreCommit {
	return dag
		.preCommit(preCommitVersion)
		.withContainer(ctr)
}

source() 🔗

Return Type

Directory !

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string source

func (m *MyModule) Example(preCommitVersion string) *dagger.Directory  {
	return dag.
			PreCommit(preCommitVersion).
			Source()
}

@function
def example(pre_commit_version: str) -> dagger.Directory:
	return (
		dag.pre_commit(pre_commit_version)
		.source()
	)

@func()
example(preCommitVersion: string): Directory {
	return dag
		.preCommit(preCommitVersion)
		.source()
}

withSource() 🔗

Return Type

PreCommit !

Arguments

Name	Type	Default Value	Description
path	Directory !	-	A directory.

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string with-source --path DIR_PATH

func (m *MyModule) Example(preCommitVersion string, path *dagger.Directory) *dagger.PreCommit  {
	return dag.
			PreCommit(preCommitVersion).
			WithSource(path)
}

@function
def example(pre_commit_version: str, path: dagger.Directory) -> dagger.PreCommit:
	return (
		dag.pre_commit(pre_commit_version)
		.with_source(path)
	)

@func()
example(preCommitVersion: string, path: Directory): PreCommit {
	return dag
		.preCommit(preCommitVersion)
		.withSource(path)
}

withRun() 🔗

Return Type

PreCommit !

Arguments

Name	Type	Default Value	Description
hookStage	String	null	No description provided

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string with-run

func (m *MyModule) Example(preCommitVersion string) *dagger.PreCommit  {
	return dag.
			PreCommit(preCommitVersion).
			WithRun()
}

@function
def example(pre_commit_version: str) -> dagger.PreCommit:
	return (
		dag.pre_commit(pre_commit_version)
		.with_run()
	)

@func()
example(preCommitVersion: string): PreCommit {
	return dag
		.preCommit(preCommitVersion)
		.withRun()
}

run() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
hookStage	String	null	No description provided

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string run

func (m *MyModule) Example(ctx context.Context, preCommitVersion string) string  {
	return dag.
			PreCommit(preCommitVersion).
			Run(ctx)
}

@function
async def example(pre_commit_version: str) -> str:
	return await (
		dag.pre_commit(pre_commit_version)
		.run()
	)

@func()
async example(preCommitVersion: string): Promise<string> {
	return dag
		.preCommit(preCommitVersion)
		.run()
}

base() 🔗

Return Type

Container !

Example

dagger -m github.com/skycaptain/daggerverse/pre-commit@20e326a304082c3d2c176b3b2accde5ff2775c0d call \
 --pre-commit-version string base

func (m *MyModule) Example(preCommitVersion string) *dagger.Container  {
	return dag.
			PreCommit(preCommitVersion).
			Base()
}

@function
def example(pre_commit_version: str) -> dagger.Container:
	return (
		dag.pre_commit(pre_commit_version)
		.base()
	)

@func()
example(preCommitVersion: string): Container {
	return dag
		.preCommit(preCommitVersion)
		.base()
}