repository-linting
Installation
Entrypoint
Types
RepositoryLinting

repository-linting

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/stuttgart-things/blueprints/repository-linting@v1.15.0

Entrypoint

Return Type

RepositoryLinting

Example

dagger -m github.com/stuttgart-things/blueprints/repository-linting@f909521e922ee17bbdbc8329df8ca10fbbf8883c call \

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

@function
def example() -> dagger.RepositoryLinting:
	return (
		dag.repository_linting()
	)

@func()
example(): RepositoryLinting {
	return dag
		.repositoryLinting()
}

Types

RepositoryLinting 🔗

validateMultipleTechnologies() 🔗

Return Type

File !

Arguments

Name	Type	Default Value	Description
yamlConfigPath	String	".yamllint"	No description provided
yamlOutputFile	String	"yamllint-findings.txt"	No description provided
markdownConfigPath	String	".mdlrc"	No description provided
markdownOutputFile	String	"markdown-findings.txt"	No description provided
mergedOutputFile	String	"all-findings.txt"	No description provided
src	Directory !	-	No description provided

Example

dagger -m github.com/stuttgart-things/blueprints/repository-linting@f909521e922ee17bbdbc8329df8ca10fbbf8883c call \
 validate-multiple-technologies --src DIR_PATH

func (m *MyModule) Example(src *dagger.Directory) *dagger.File  {
	return dag.
			RepositoryLinting().
			ValidateMultipleTechnologies(src)
}

@function
def example(src: dagger.Directory) -> dagger.File:
	return (
		dag.repository_linting()
		.validate_multiple_technologies(src)
	)

@func()
example(src: Directory): File {
	return dag
		.repositoryLinting()
		.validateMultipleTechnologies(src)
}

lintYaml() 🔗

LintYAML lints YAML files in the provided directory

Return Type

File !

Arguments

Name	Type	Default Value	Description
configPath	String	".yamllint"	No description provided
outputFile	String	"yamllint-findings.txt"	No description provided
src	Directory !	-	No description provided

Example

dagger -m github.com/stuttgart-things/blueprints/repository-linting@f909521e922ee17bbdbc8329df8ca10fbbf8883c call \
 lint-yaml --src DIR_PATH

func (m *MyModule) Example(src *dagger.Directory) *dagger.File  {
	return dag.
			RepositoryLinting().
			LintYaml(src)
}

@function
def example(src: dagger.Directory) -> dagger.File:
	return (
		dag.repository_linting()
		.lint_yaml(src)
	)

@func()
example(src: Directory): File {
	return dag
		.repositoryLinting()
		.lintYaml(src)
}

lintMarkdown() 🔗

LintYAML lints YAML files in the provided directory

Return Type

File !

Arguments

Name	Type	Default Value	Description
configPath	String	".mdlrc"	No description provided
outputFile	String	"markdown-findings.txt"	No description provided
src	Directory !	-	No description provided

Example

dagger -m github.com/stuttgart-things/blueprints/repository-linting@f909521e922ee17bbdbc8329df8ca10fbbf8883c call \
 lint-markdown --src DIR_PATH

func (m *MyModule) Example(src *dagger.Directory) *dagger.File  {
	return dag.
			RepositoryLinting().
			LintMarkdown(src)
}

@function
def example(src: dagger.Directory) -> dagger.File:
	return (
		dag.repository_linting()
		.lint_markdown(src)
	)

@func()
example(src: Directory): File {
	return dag
		.repositoryLinting()
		.lintMarkdown(src)
}