editorconfig
This module has been generated via dagger init and serves as a reference tobasic 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/softwaredevelop/daggerverse/editorconfig@77e86ca46de91dfc397dd4a26eb180eec25bca79
Entrypoint
Return Type
Editorconfig !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
image | String | - | Custom image reference in "repository:tag" format to use as a base container. |
Example
dagger -m github.com/softwaredevelop/daggerverse/editorconfig@77e86ca46de91dfc397dd4a26eb180eec25bca79 call \
func (m *myModule) example() *Editorconfig {
return dag.
Editorconfig()
}
@function
def example() -> dag.Editorconfig:
return (
dag.editorconfig()
)
@func()
example(): Editorconfig {
return dag
.editorconfig()
}
Types
Editorconfig 🔗
Editorconfig is a module for checking editorconfig files.
image() 🔗
Return Type
String !
Example
dagger -m github.com/softwaredevelop/daggerverse/editorconfig@77e86ca46de91dfc397dd4a26eb180eec25bca79 call \
image
func (m *myModule) example(ctx context.Context) string {
return dag.
Editorconfig().
Image(ctx)
}
@function
async def example() -> str:
return await (
dag.editorconfig()
.image()
)
@func()
async example(): Promise<string> {
return dag
.editorconfig()
.image()
}
ctr() 🔗
Return Type
Container !
Example
dagger -m github.com/softwaredevelop/daggerverse/editorconfig@77e86ca46de91dfc397dd4a26eb180eec25bca79 call \
ctr
func (m *myModule) example() *Container {
return dag.
Editorconfig().
Ctr()
}
@function
def example() -> dagger.Container:
return (
dag.editorconfig()
.ctr()
)
@func()
example(): Container {
return dag
.editorconfig()
.ctr()
}
container() 🔗
Container returns the underlying Dagger container
Return Type
Container !
Example
dagger -m github.com/softwaredevelop/daggerverse/editorconfig@77e86ca46de91dfc397dd4a26eb180eec25bca79 call \
container
func (m *myModule) example() *Container {
return dag.
Editorconfig().
Container()
}
@function
def example() -> dagger.Container:
return (
dag.editorconfig()
.container()
)
@func()
example(): Container {
return dag
.editorconfig()
.container()
}
check() 🔗
Check runs the editorconfig-checker command.
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | Source directory |
excludeDirectoryPattern | String ! | ".git" | excludeDirectoryPattern is an optional argument that specifies a pattern to exclude directories. |
Example
dagger -m github.com/softwaredevelop/daggerverse/editorconfig@77e86ca46de91dfc397dd4a26eb180eec25bca79 call \
check --source DIR_PATH --exclude-directory-pattern string
func (m *myModule) example(source *Directory, excludeDirectoryPattern string) *Container {
return dag.
Editorconfig().
Check(source, excludeDirectoryPattern)
}
@function
def example(source: dagger.Directory, exclude_directory_pattern: str) -> dagger.Container:
return (
dag.editorconfig()
.check(source, exclude_directory_pattern)
)
@func()
example(source: Directory, excludeDirectoryPattern: string): Container {
return dag
.editorconfig()
.check(source, excludeDirectoryPattern)
}