Dagger
Search

pre-commit

No long description provided.

Installation

dagger install github.com/skycaptain/daggerverse/pre-commit@2157d21c9fbbf0497c5253f5a490a15cbce1ccdf

Entrypoint

Return Type 
PreCommit !
Arguments
NameTypeDescription
preCommitVersionString !No description provided
Example
func (m *myModule) example(preCommitVersion string) *PreCommit  {
	return dag.
			PreCommit(preCommitVersion)
}
@function
def example(pre_commit_version: str) -> dag.PreCommit:
	return (
		dag.pre_commit(pre_commit_version)
	)
@func()
example(preCommitVersion: string): PreCommit {
	return dag
		.preCommit(preCommitVersion)
}

Types

PreCommit 🔗

container() 🔗

Return Type 
Container !
Example
func (m *myModule) example(preCommitVersion string) *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
NameTypeDefault ValueDescription
ctrContainer !-An OCI-compatible container, also known as a Docker container.
Example
func (m *myModule) example(preCommitVersion string, ctr *Container) *PreCommit  {
	return dag.
			PreCommit(preCommitVersion).
			WithContainer(ctr)
}
@function
def example(pre_commit_version: str, ctr: dagger.Container) -> dag.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
func (m *myModule) example(preCommitVersion string) *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
NameTypeDefault ValueDescription
pathDirectory !-A directory.
Example
func (m *myModule) example(preCommitVersion string, path *Directory) *PreCommit  {
	return dag.
			PreCommit(preCommitVersion).
			WithSource(path)
}
@function
def example(pre_commit_version: str, path: dagger.Directory) -> dag.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
NameTypeDefault ValueDescription
hookStageString nullNo description provided
Example
func (m *myModule) example(preCommitVersion string) *PreCommit  {
	return dag.
			PreCommit(preCommitVersion).
			WithRun()
}
@function
def example(pre_commit_version: str) -> dag.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
NameTypeDefault ValueDescription
hookStageString nullNo description provided
Example
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
func (m *myModule) example(preCommitVersion string) *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()
}