tflint
Installation
Entrypoint
Types
Tflint

tflint

No long description provided.

Installation

dagger install github.com/Excoriate/daggerverse/tflint@v1.10.0

Entrypoint

Return Type

Tflint !

Arguments

Name	Type	Description
version	String	version is the version of the TFLint to use, e.g., "v0.50.3". For more information, see https://github.com/terraform-linters/tflint
image	String	image is the image to use as the base container.
src	Directory !	src is the directory that contains all the source code, including the module directory.
ctr	Container	Ctrl is the container to use as a base container.

Example

func (m *myModule) example(src *Directory) *Tflint  {
	return dag.
			Tflint(src)
}

@function
def example(src: dagger.Directory, ) -> dag.Tflint:
	return (
		dag.tflint(src)
	)

@func()
example(src: Directory, ): Tflint {
	return dag
		.tflint(src)
}

Types

Tflint 🔗

src() 🔗

Src is the directory that contains all the source code, including the module directory.

Return Type

Directory !

Example

func (m *myModule) example(src *Directory) *Directory  {
	return dag.
			Tflint(src).
			Src()
}

@function
def example(src: dagger.Directory, ) -> dagger.Directory:
	return (
		dag.tflint(src)
		.src()
	)

@func()
example(src: Directory, ): Directory {
	return dag
		.tflint(src)
		.src()
}

ctr() 🔗

Ctr is the container to use as a base container.

Return Type

Container !

Example

func (m *myModule) example(src *Directory) *Container  {
	return dag.
			Tflint(src).
			Ctr()
}

@function
def example(src: dagger.Directory, ) -> dagger.Container:
	return (
		dag.tflint(src)
		.ctr()
	)

@func()
example(src: Directory, ): Container {
	return dag
		.tflint(src)
		.ctr()
}

base() 🔗

Base sets the base image and version, and creates the base container.

Return Type

Tflint !

Arguments

Name	Type	Default Value	Description
image	String !	-	No description provided
version	String !	-	No description provided

Example

func (m *myModule) example(src *Directory, image string, version string) *Tflint  {
	return dag.
			Tflint(src).
			Base(image, version)
}

@function
def example(src: dagger.Directory, image: str, version: str) -> dag.Tflint:
	return (
		dag.tflint(src)
		.base(image, version)
	)

@func()
example(src: Directory, image: string, version: string): Tflint {
	return dag
		.tflint(src)
		.base(image, version)
}

withSource() 🔗

WithSource sets the source directory if it’s passed, and mounts the source directory to the container.

Return Type

Tflint !

Arguments

Name	Type	Default Value	Description
src	Directory !	-	No description provided

Example

func (m *myModule) example(src *Directory, src1 *Directory) *Tflint  {
	return dag.
			Tflint(src).
			WithSource(src1)
}

@function
def example(src: dagger.Directory, src1: dagger.Directory) -> dag.Tflint:
	return (
		dag.tflint(src)
		.with_source(src1)
	)

@func()
example(src: Directory, src1: Directory): Tflint {
	return dag
		.tflint(src)
		.withSource(src1)
}

version() 🔗

Version runs the ‘tflint –version’ command.

Return Type

String !

Example

func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Tflint(src).
			Version(ctx)
}

@function
async def example(src: dagger.Directory, ) -> str:
	return await (
		dag.tflint(src)
		.version()
	)

@func()
async example(src: Directory, ): Promise<string> {
	return dag
		.tflint(src)
		.version()
}

run() 🔗

Run executes any tflint command.

Return Type

String !

Arguments

Name	Type	Default Value	Description
cfg	String	-	cfg is the configuration file to use.
args	String	-	args is the arguments to pass to the tfLint command.

Example

func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Tflint(src).
			Run(ctx)
}

@function
async def example(src: dagger.Directory, ) -> str:
	return await (
		dag.tflint(src)
		.run()
	)

@func()
async example(src: Directory, ): Promise<string> {
	return dag
		.tflint(src)
		.run()
}

withInit() 🔗

WithInit adds the ‘init’ command to the container.

Return Type

Tflint !

Arguments

Name	Type	Default Value	Description
cfg	String	-	cfg is the configuration file to use.
args	String	-	args is the arguments to pass to the tfLint init command.

Example

func (m *myModule) example(src *Directory) *Tflint  {
	return dag.
			Tflint(src).
			WithInit()
}

@function
def example(src: dagger.Directory, ) -> dag.Tflint:
	return (
		dag.tflint(src)
		.with_init()
	)

@func()
example(src: Directory, ): Tflint {
	return dag
		.tflint(src)
		.withInit()
}

runInit() 🔗

RunInit executes the ‘init’ command.

Return Type

String !

Arguments

Name	Type	Default Value	Description
cfg	String	-	cfg is the configuration file to use.
args	String	-	args is the arguments to pass to the tfLint init command.

Example

func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Tflint(src).
			RunInit(ctx)
}

@function
async def example(src: dagger.Directory, ) -> str:
	return await (
		dag.tflint(src)
		.run_init()
	)

@func()
async example(src: Directory, ): Promise<string> {
	return dag
		.tflint(src)
		.runInit()
}

lint() 🔗

Return Type

Tflint !

Arguments

Name	Type	Default Value	Description
init	Boolean	false	init specifies whether to run the 'init' command before running the 'lint' command.
cfg	String	-	cfg is the configuration file to use.
args	String	-	args is the arguments to pass to the tfLint init command.

Example

func (m *myModule) example(src *Directory) *Tflint  {
	return dag.
			Tflint(src).
			Lint()
}

@function
def example(src: dagger.Directory, ) -> dag.Tflint:
	return (
		dag.tflint(src)
		.lint()
	)

@func()
example(src: Directory, ): Tflint {
	return dag
		.tflint(src)
		.lint()
}

runLint() 🔗

RunLint executes the ‘init’ command. It’s equivalent to running ‘tflint’ in the terminal.

Return Type

String !

Arguments

Name	Type	Default Value	Description
init	Boolean	false	init specifies whether to run the 'init' command before running the 'lint' command.
cfg	String	-	cfg is the configuration file to use.
args	String	-	args is the arguments to pass to the tfLint init command.

Example

func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Tflint(src).
			RunLint(ctx)
}

@function
async def example(src: dagger.Directory, ) -> str:
	return await (
		dag.tflint(src)
		.run_lint()
	)

@func()
async example(src: Directory, ): Promise<string> {
	return dag
		.tflint(src)
		.runLint()
}