cubzh
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/cubzh/cubzh@cce6a2f110f93d1b583029304fd99ae501e035c2
Entrypoint
Return Type
Cubzh
Example
dagger -m github.com/cubzh/cubzh@cce6a2f110f93d1b583029304fd99ae501e035c2 call \
func (m *myModule) example() *Cubzh {
return dag.
Cubzh()
}
@function
def example() -> dag.Cubzh:
return (
dag.cubzh()
)
@func()
example(): Cubzh {
return dag
.cubzh()
}
Types
Cubzh 🔗
testCore() 🔗
Run core unit tests
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory | - | Source code |
Example
dagger -m github.com/cubzh/cubzh@cce6a2f110f93d1b583029304fd99ae501e035c2 call \
test-core
func (m *myModule) example(ctx context.Context) {
return dag.
Cubzh().
TestCore(ctx)
}
@function
async def example() -> None:
return await (
dag.cubzh()
.test_core()
)
@func()
async example(): Promise<void> {
return dag
.cubzh()
.testCore()
}
lintCore() 🔗
Lint the core source code
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory | - | Core source directory |
Example
dagger -m github.com/cubzh/cubzh@cce6a2f110f93d1b583029304fd99ae501e035c2 call \
lint-core
func (m *myModule) example(ctx context.Context) {
return dag.
Cubzh().
LintCore(ctx)
}
@function
async def example() -> None:
return await (
dag.cubzh()
.lint_core()
)
@func()
async example(): Promise<void> {
return dag
.cubzh()
.lintCore()
}
formatCore() 🔗
Format the core source code using clang tools
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory | - | Source code to format |
check | Boolean | - | Only check, don't fix |
Example
dagger -m github.com/cubzh/cubzh@cce6a2f110f93d1b583029304fd99ae501e035c2 call \
format-core
func (m *myModule) example() *Directory {
return dag.
Cubzh().
FormatCore()
}
@function
def example() -> dagger.Directory:
return (
dag.cubzh()
.format_core()
)
@func()
example(): Directory {
return dag
.cubzh()
.formatCore()
}
luaDev() 🔗
Build a Lua dev container with modules source code mounted
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory | - | Lua modules source code |
Example
dagger -m github.com/cubzh/cubzh@cce6a2f110f93d1b583029304fd99ae501e035c2 call \
lua-dev
func (m *myModule) example() *Container {
return dag.
Cubzh().
LuaDev()
}
@function
def example() -> dagger.Container:
return (
dag.cubzh()
.lua_dev()
)
@func()
example(): Container {
return dag
.cubzh()
.luaDev()
}
lintModules() 🔗
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory | - | Modules source directory |
Example
dagger -m github.com/cubzh/cubzh@cce6a2f110f93d1b583029304fd99ae501e035c2 call \
lint-modules
func (m *myModule) example(ctx context.Context) {
return dag.
Cubzh().
LintModules(ctx)
}
@function
async def example() -> None:
return await (
dag.cubzh()
.lint_modules()
)
@func()
async example(): Promise<void> {
return dag
.cubzh()
.lintModules()
}