spectral
No long description provided.
Installation
dagger install github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8
Entrypoint
Return Type
Spectral
Example
dagger -m github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8 call \
func (m *MyModule) Example() *dagger.Spectral {
return dag.
Spectral()
}
@function
def example() -> dagger.Spectral:
return (
dag.spectral()
)
@func()
example(): Spectral {
return dag
.spectral()
}
Types
Spectral 🔗
fromVersion() 🔗
Specify which version (image tag) of Spectral to use from the official image repository on Docker Hub.
Return Type
Base !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
version | StringKind ! | - | No description provided |
Example
dagger -m github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8 call \
from-version
func (m *MyModule) Example(version ) {
return dag.
Spectral().
FromVersion(version)
}
@function
def example(version: ) -> :
return (
dag.spectral()
.from_version(version)
)
@func()
example(version: ): {
return dag
.spectral()
.fromVersion(version)
}
fromImage() 🔗
Specify a custom image reference in “repository:tag” format.
Return Type
Base !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
image | StringKind ! | - | No description provided |
Example
dagger -m github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8 call \
from-image
func (m *MyModule) Example(image ) {
return dag.
Spectral().
FromImage(image)
}
@function
def example(image: ) -> :
return (
dag.spectral()
.from_image(image)
)
@func()
example(image: ): {
return dag
.spectral()
.fromImage(image)
}
fromContainer() 🔗
Specify a custom container.
Return Type
Base !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
ctr | Container ! | - | No description provided |
Example
dagger -m github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8 call \
from-container
func (m *MyModule) Example(ctr ) {
return dag.
Spectral().
FromContainer(ctr)
}
@function
def example(ctr: ) -> :
return (
dag.spectral()
.from_container(ctr)
)
@func()
example(ctr: ): {
return dag
.spectral()
.fromContainer(ctr)
}
withSource() 🔗
Mount a source directory.
Return Type
BaseWithSource !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
dagger -m github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8 call \
with-source
func (m *MyModule) Example(src ) {
return dag.
Spectral().
WithSource(src)
}
@function
def example(src: ) -> :
return (
dag.spectral()
.with_source(src)
)
@func()
example(src: ): {
return dag
.spectral()
.withSource(src)
}
lint() 🔗
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
document | StringKind ! | - | No description provided |
version | StringKind | - | No description provided |
image | StringKind | - | No description provided |
container | Container | - | No description provided |
source | Directory | - | No description provided |
Example
dagger -m github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8 call \
lint
func (m *MyModule) Example(document ) {
return dag.
Spectral().
Lint(document)
}
@function
def example(document: ) -> :
return (
dag.spectral()
.lint(document)
)
@func()
example(document: ): {
return dag
.spectral()
.lint(document)
}
container() 🔗
Return the default container.
Return Type
Container !
Example
dagger -m github.com/sagikazarmark/daggerverse/spectral@93e56d3af8e970a95b877992d7ce2f6ae6c664c8 call \
container
func (m *MyModule) Example() {
return dag.
Spectral().
Container()
}
@function
def example() -> :
return (
dag.spectral()
.container()
)
@func()
example(): {
return dag
.spectral()
.container()
}
Base 🔗
ctr() 🔗
Return Type
Container !
Example
Function SpectralBase.Ctr is not accessible from the spectral module
Function SpectralBase.Ctr is not accessible from the spectral module
Function SpectralBase.Ctr is not accessible from the spectral module
Function SpectralBase.Ctr is not accessible from the spectral module
container() 🔗
Return the default container.
Return Type
Container !
Example
Function SpectralBase.container is not accessible from the spectral module
Function SpectralBase.container is not accessible from the spectral module
Function SpectralBase.container is not accessible from the spectral module
Function SpectralBase.container is not accessible from the spectral module
withSource() 🔗
Mount a source directory.
Return Type
BaseWithSource !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
Function SpectralBase.withSource is not accessible from the spectral module
Function SpectralBase.withSource is not accessible from the spectral module
Function SpectralBase.withSource is not accessible from the spectral module
Function SpectralBase.withSource is not accessible from the spectral module
lint() 🔗
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
document | StringKind ! | - | No description provided |
source | Directory | - | No description provided |
Example
Function SpectralBase.lint is not accessible from the spectral module
Function SpectralBase.lint is not accessible from the spectral module
Function SpectralBase.lint is not accessible from the spectral module
Function SpectralBase.lint is not accessible from the spectral module
BaseWithSource 🔗
base() 🔗
Return Type
Base !
Example
Function SpectralBaseWithSource.Base is not accessible from the spectral module
Function SpectralBaseWithSource.Base is not accessible from the spectral module
Function SpectralBaseWithSource.Base is not accessible from the spectral module
Function SpectralBaseWithSource.Base is not accessible from the spectral module
container() 🔗
Return the default container.
Return Type
Container !
Example
Function SpectralBaseWithSource.container is not accessible from the spectral module
Function SpectralBaseWithSource.container is not accessible from the spectral module
Function SpectralBaseWithSource.container is not accessible from the spectral module
Function SpectralBaseWithSource.container is not accessible from the spectral module
withSource() 🔗
Mount a source directory.
Return Type
BaseWithSource !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
Function SpectralBaseWithSource.withSource is not accessible from the spectral module
Function SpectralBaseWithSource.withSource is not accessible from the spectral module
Function SpectralBaseWithSource.withSource is not accessible from the spectral module
Function SpectralBaseWithSource.withSource is not accessible from the spectral module
lint() 🔗
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
document | StringKind ! | - | No description provided |
Example
Function SpectralBaseWithSource.lint is not accessible from the spectral module
Function SpectralBaseWithSource.lint is not accessible from the spectral module
Function SpectralBaseWithSource.lint is not accessible from the spectral module
Function SpectralBaseWithSource.lint is not accessible from the spectral module