generate

package

v0.4.22 Latest Latest Go to latest Published: Apr 12, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Commands(path string, options CommandOptions)

Commands generates the microservice commands based of the given path

func Dockerfile(path string, options DockerfileOptions)

Dockerfile generate a dockerfile using the given options for specified path

func ErrorDefinitionFile(options ErrorDefinitionFileOptions)

ErrorDefinitionFile builds a file with error definitions

func ErrorDefinitionsMarkdown(options ErrorDefinitionFileOptions)

func Makefile(path string, options MakefileOptions)

Makefile generates a with given options for the specified path

func Rest(options RestOptions)

Rest builds a jsonapi rest api

type CommandOptions struct {
	DaemonName  string
	ControlName string
}

CommandOptions are applied when generating the different microservice commands

func NewCommandOptions(name string) CommandOptions

NewCommandOptions generate command names using given name

type DockerfileOptions struct {
	Name     string
	Commands CommandOptions
}

DockerfileOptions configure the output of the generated docker file

type ErrorDefinitionFileOptions struct {
	PkgName, Path, Source string
}

ErrorDefinitionFileOptions options that change the rendering of the error definition file

type MakefileOptions struct {
	Name string
}

MakefileOptions options that change the rendering of the makefile

type RestOptions struct {
	PkgName, Path, Source string
}

RestOptions options to respect when generating the rest api

Path	Synopsis
errordefinition
generator