commitlint

commit policy using commitlint.

Installation

dagger install github.com/MacroPower/x/toolchains/commitlint@1c64479e2bfcaf14befc12f8647edff645eead44

Commitlint !

Name	Type	Default Value	Description
image	String	-	Container image with commitlint installed.

Example

dagger -m github.com/MacroPower/x/toolchains/commitlint@1c64479e2bfcaf14befc12f8647edff645eead44 call \

func (m *MyModule) Example() *dagger.Commitlint  {
	return dag.
			Commitlint()
}

@function
def example() -> dagger.Commitlint:
	return (
		dag.commitlint()
	)

@func()
example(): Commitlint {
	return dag
		.commitlint()
}

Commitlint validates commit messages against a project's conventional commit policy. Create instances with [New].

Container image with commitlint installed.

String !

Example

dagger -m github.com/MacroPower/x/toolchains/commitlint@1c64479e2bfcaf14befc12f8647edff645eead44 call \
 image

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

@function
async def example() -> str:
	return await (
		dag.commitlint()
		.image()
	)

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

Lint validates commit messages against the project’s commitlint configuration.

Void !

Name	Type	Default Value	Description
source	Directory !	-	Project source directory containing the commitlint config.
msgFile	File	-	Commit message file to validate (e.g. .git/COMMIT_EDITMSG).
args	[String ! ]	-	Arguments to pass to commitlint.

Example

dagger -m github.com/MacroPower/x/toolchains/commitlint@1c64479e2bfcaf14befc12f8647edff645eead44 call \
 lint --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory)   {
	return dag.
			Commitlint().
			Lint(ctx, source)
}

@function
async def example(source: dagger.Directory) -> None:
	return await (
		dag.commitlint()
		.lint(source)
	)

@func()
async example(source: Directory): Promise<void> {
	return dag
		.commitlint()
		.lint(source)
}